Package io.redvox.apis
Class RedvoxApiM.RedvoxPacketM.TimingInformation
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.redvox.apis.RedvoxApiM.RedvoxPacketM.TimingInformation
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,RedvoxApiM.RedvoxPacketM.TimingInformationOrBuilder,Serializable
- Enclosing class:
- RedvoxApiM.RedvoxPacketM
public static final class RedvoxApiM.RedvoxPacketM.TimingInformation
extends com.google.protobuf.GeneratedMessageV3
implements RedvoxApiM.RedvoxPacketM.TimingInformationOrBuilder
Stores timing information and related metrics See: https://github.com/RedVoxInc/redvox-api-1000/src/master/docs/standards/keeping_time.mdProtobuf type
redvox_api_m.RedvoxPacketM.TimingInformation- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classStores timing information and related metrics See: https://github.com/RedVoxInc/redvox-api-1000/src/master/docs/standards/keeping_time.mdstatic final classType-safe synchronization exchange valuesstatic interfacestatic enumMethod used to score timing metricsNested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType, BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleancontainsMetadata(String key) A map from string to string for including untyped metadatabooleandoubleThe start of the app as machine timefloatThe best latency as determined from the synch params in microsecondsfloatThe best offset as determined from the synch params in microsecondsstatic final com.google.protobuf.Descriptors.DescriptorDeprecated.intA map from string to string for including untyped metadataA map from string to string for including untyped metadatagetMetadataOrDefault(String key, String defaultValue) A map from string to string for including untyped metadatagetMetadataOrThrow(String key) A map from string to string for including untyped metadatadoubleEnd timestamp of the packet using machine time (corresponding to the last audio sample)doubleEnd timestamp of the packet using the os clock (corresponding to the last audio sample)doubleStart timestamp of the packet using machine time (corresponding to the first audio sample)doubleStart timestamp of the packet using the os clock (corresponding to first audio sample)com.google.protobuf.Parser<RedvoxApiM.RedvoxPacketM.TimingInformation>floatgetScore()The overall timing scoreMethod used to provide scoreintMethod used to provide scoreintdoubleTimestamp that the packet arrived at the acquisition servergetSynchExchanges(int index) An array of synchronization params from the synch serverintAn array of synchronization params from the synch serverAn array of synchronization params from the synch servergetSynchExchangesOrBuilder(int index) An array of synchronization params from the synch serverAn array of synchronization params from the synch servergetUnit()A unit describing the time (should always be MICROSECONDS_SINCE_UNIX_EPOCH)intA unit describing the time (should always be MICROSECONDS_SINCE_UNIX_EPOCH)final com.google.protobuf.UnknownFieldSetinthashCode()protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableprotected com.google.protobuf.MapFieldinternalGetMapField(int number) final booleannewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) parseDelimitedFrom(InputStream input) parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(byte[] data) parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(com.google.protobuf.ByteString data) parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(com.google.protobuf.CodedInputStream input) parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(InputStream input) parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) parseFrom(ByteBuffer data) parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<RedvoxApiM.RedvoxPacketM.TimingInformation>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
-
Field Details
-
PACKET_START_OS_TIMESTAMP_FIELD_NUMBER
public static final int PACKET_START_OS_TIMESTAMP_FIELD_NUMBER- See Also:
-
PACKET_START_MACH_TIMESTAMP_FIELD_NUMBER
public static final int PACKET_START_MACH_TIMESTAMP_FIELD_NUMBER- See Also:
-
PACKET_END_OS_TIMESTAMP_FIELD_NUMBER
public static final int PACKET_END_OS_TIMESTAMP_FIELD_NUMBER- See Also:
-
PACKET_END_MACH_TIMESTAMP_FIELD_NUMBER
public static final int PACKET_END_MACH_TIMESTAMP_FIELD_NUMBER- See Also:
-
SERVER_ACQUISITION_ARRIVAL_TIMESTAMP_FIELD_NUMBER
public static final int SERVER_ACQUISITION_ARRIVAL_TIMESTAMP_FIELD_NUMBER- See Also:
-
APP_START_MACH_TIMESTAMP_FIELD_NUMBER
public static final int APP_START_MACH_TIMESTAMP_FIELD_NUMBER- See Also:
-
SYNCH_EXCHANGES_FIELD_NUMBER
public static final int SYNCH_EXCHANGES_FIELD_NUMBER- See Also:
-
BEST_LATENCY_FIELD_NUMBER
public static final int BEST_LATENCY_FIELD_NUMBER- See Also:
-
BEST_OFFSET_FIELD_NUMBER
public static final int BEST_OFFSET_FIELD_NUMBER- See Also:
-
SCORE_FIELD_NUMBER
public static final int SCORE_FIELD_NUMBER- See Also:
-
SCORE_METHOD_FIELD_NUMBER
public static final int SCORE_METHOD_FIELD_NUMBER- See Also:
-
UNIT_FIELD_NUMBER
public static final int UNIT_FIELD_NUMBER- See Also:
-
METADATA_FIELD_NUMBER
public static final int METADATA_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getUnknownFields
public final com.google.protobuf.UnknownFieldSet getUnknownFields()- Specified by:
getUnknownFieldsin interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapField
protected com.google.protobuf.MapField internalGetMapField(int number) - Overrides:
internalGetMapFieldin classcom.google.protobuf.GeneratedMessageV3
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
getPacketStartOsTimestamp
public double getPacketStartOsTimestamp()Start timestamp of the packet using the os clock (corresponding to first audio sample)
double packet_start_os_timestamp = 1;- Specified by:
getPacketStartOsTimestampin interfaceRedvoxApiM.RedvoxPacketM.TimingInformationOrBuilder- Returns:
- The packetStartOsTimestamp.
-
getPacketStartMachTimestamp
public double getPacketStartMachTimestamp()Start timestamp of the packet using machine time (corresponding to the first audio sample)
double packet_start_mach_timestamp = 2;- Specified by:
getPacketStartMachTimestampin interfaceRedvoxApiM.RedvoxPacketM.TimingInformationOrBuilder- Returns:
- The packetStartMachTimestamp.
-
getPacketEndOsTimestamp
public double getPacketEndOsTimestamp()End timestamp of the packet using the os clock (corresponding to the last audio sample)
double packet_end_os_timestamp = 3;- Specified by:
getPacketEndOsTimestampin interfaceRedvoxApiM.RedvoxPacketM.TimingInformationOrBuilder- Returns:
- The packetEndOsTimestamp.
-
getPacketEndMachTimestamp
public double getPacketEndMachTimestamp()End timestamp of the packet using machine time (corresponding to the last audio sample)
double packet_end_mach_timestamp = 4;- Specified by:
getPacketEndMachTimestampin interfaceRedvoxApiM.RedvoxPacketM.TimingInformationOrBuilder- Returns:
- The packetEndMachTimestamp.
-
getServerAcquisitionArrivalTimestamp
public double getServerAcquisitionArrivalTimestamp()Timestamp that the packet arrived at the acquisition server
double server_acquisition_arrival_timestamp = 5;- Specified by:
getServerAcquisitionArrivalTimestampin interfaceRedvoxApiM.RedvoxPacketM.TimingInformationOrBuilder- Returns:
- The serverAcquisitionArrivalTimestamp.
-
getAppStartMachTimestamp
public double getAppStartMachTimestamp()The start of the app as machine time
double app_start_mach_timestamp = 6;- Specified by:
getAppStartMachTimestampin interfaceRedvoxApiM.RedvoxPacketM.TimingInformationOrBuilder- Returns:
- The appStartMachTimestamp.
-
getSynchExchangesList
An array of synchronization params from the synch server
repeated .redvox_api_m.RedvoxPacketM.TimingInformation.SynchExchange synch_exchanges = 7;- Specified by:
getSynchExchangesListin interfaceRedvoxApiM.RedvoxPacketM.TimingInformationOrBuilder
-
getSynchExchangesOrBuilderList
public List<? extends RedvoxApiM.RedvoxPacketM.TimingInformation.SynchExchangeOrBuilder> getSynchExchangesOrBuilderList()An array of synchronization params from the synch server
repeated .redvox_api_m.RedvoxPacketM.TimingInformation.SynchExchange synch_exchanges = 7;- Specified by:
getSynchExchangesOrBuilderListin interfaceRedvoxApiM.RedvoxPacketM.TimingInformationOrBuilder
-
getSynchExchangesCount
public int getSynchExchangesCount()An array of synchronization params from the synch server
repeated .redvox_api_m.RedvoxPacketM.TimingInformation.SynchExchange synch_exchanges = 7;- Specified by:
getSynchExchangesCountin interfaceRedvoxApiM.RedvoxPacketM.TimingInformationOrBuilder
-
getSynchExchanges
An array of synchronization params from the synch server
repeated .redvox_api_m.RedvoxPacketM.TimingInformation.SynchExchange synch_exchanges = 7;- Specified by:
getSynchExchangesin interfaceRedvoxApiM.RedvoxPacketM.TimingInformationOrBuilder
-
getSynchExchangesOrBuilder
public RedvoxApiM.RedvoxPacketM.TimingInformation.SynchExchangeOrBuilder getSynchExchangesOrBuilder(int index) An array of synchronization params from the synch server
repeated .redvox_api_m.RedvoxPacketM.TimingInformation.SynchExchange synch_exchanges = 7;- Specified by:
getSynchExchangesOrBuilderin interfaceRedvoxApiM.RedvoxPacketM.TimingInformationOrBuilder
-
getBestLatency
public float getBestLatency()The best latency as determined from the synch params in microseconds
float best_latency = 8;- Specified by:
getBestLatencyin interfaceRedvoxApiM.RedvoxPacketM.TimingInformationOrBuilder- Returns:
- The bestLatency.
-
getBestOffset
public float getBestOffset()The best offset as determined from the synch params in microseconds
float best_offset = 9;- Specified by:
getBestOffsetin interfaceRedvoxApiM.RedvoxPacketM.TimingInformationOrBuilder- Returns:
- The bestOffset.
-
getScore
public float getScore()The overall timing score
float score = 10;- Specified by:
getScorein interfaceRedvoxApiM.RedvoxPacketM.TimingInformationOrBuilder- Returns:
- The score.
-
getScoreMethodValue
public int getScoreMethodValue()Method used to provide score
.redvox_api_m.RedvoxPacketM.TimingInformation.TimingScoreMethod score_method = 11;- Specified by:
getScoreMethodValuein interfaceRedvoxApiM.RedvoxPacketM.TimingInformationOrBuilder- Returns:
- The enum numeric value on the wire for scoreMethod.
-
getScoreMethod
Method used to provide score
.redvox_api_m.RedvoxPacketM.TimingInformation.TimingScoreMethod score_method = 11;- Specified by:
getScoreMethodin interfaceRedvoxApiM.RedvoxPacketM.TimingInformationOrBuilder- Returns:
- The scoreMethod.
-
getUnitValue
public int getUnitValue()A unit describing the time (should always be MICROSECONDS_SINCE_UNIX_EPOCH)
.redvox_api_m.RedvoxPacketM.Unit unit = 12;- Specified by:
getUnitValuein interfaceRedvoxApiM.RedvoxPacketM.TimingInformationOrBuilder- Returns:
- The enum numeric value on the wire for unit.
-
getUnit
A unit describing the time (should always be MICROSECONDS_SINCE_UNIX_EPOCH)
.redvox_api_m.RedvoxPacketM.Unit unit = 12;- Specified by:
getUnitin interfaceRedvoxApiM.RedvoxPacketM.TimingInformationOrBuilder- Returns:
- The unit.
-
getMetadataCount
public int getMetadataCount()Description copied from interface:RedvoxApiM.RedvoxPacketM.TimingInformationOrBuilderA map from string to string for including untyped metadata
map<string, string> metadata = 13;- Specified by:
getMetadataCountin interfaceRedvoxApiM.RedvoxPacketM.TimingInformationOrBuilder
-
containsMetadata
A map from string to string for including untyped metadata
map<string, string> metadata = 13;- Specified by:
containsMetadatain interfaceRedvoxApiM.RedvoxPacketM.TimingInformationOrBuilder
-
getMetadata
Deprecated.UsegetMetadataMap()instead.- Specified by:
getMetadatain interfaceRedvoxApiM.RedvoxPacketM.TimingInformationOrBuilder
-
getMetadataMap
A map from string to string for including untyped metadata
map<string, string> metadata = 13;- Specified by:
getMetadataMapin interfaceRedvoxApiM.RedvoxPacketM.TimingInformationOrBuilder
-
getMetadataOrDefault
A map from string to string for including untyped metadata
map<string, string> metadata = 13;- Specified by:
getMetadataOrDefaultin interfaceRedvoxApiM.RedvoxPacketM.TimingInformationOrBuilder
-
getMetadataOrThrow
A map from string to string for including untyped metadata
map<string, string> metadata = 13;- Specified by:
getMetadataOrThrowin interfaceRedvoxApiM.RedvoxPacketM.TimingInformationOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static RedvoxApiM.RedvoxPacketM.TimingInformation parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RedvoxApiM.RedvoxPacketM.TimingInformation parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RedvoxApiM.RedvoxPacketM.TimingInformation parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RedvoxApiM.RedvoxPacketM.TimingInformation parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RedvoxApiM.RedvoxPacketM.TimingInformation parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RedvoxApiM.RedvoxPacketM.TimingInformation parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RedvoxApiM.RedvoxPacketM.TimingInformation parseFrom(InputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static RedvoxApiM.RedvoxPacketM.TimingInformation parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static RedvoxApiM.RedvoxPacketM.TimingInformation parseDelimitedFrom(InputStream input) throws IOException - Throws:
IOException
-
parseDelimitedFrom
public static RedvoxApiM.RedvoxPacketM.TimingInformation parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static RedvoxApiM.RedvoxPacketM.TimingInformation parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static RedvoxApiM.RedvoxPacketM.TimingInformation parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
public static RedvoxApiM.RedvoxPacketM.TimingInformation.Builder newBuilder(RedvoxApiM.RedvoxPacketM.TimingInformation prototype) -
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected RedvoxApiM.RedvoxPacketM.TimingInformation.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-