Media Stream Endpoint Datatypes
OcaMediaStreamEndpointID
OcaMediaStreamEndpoint
-
struct OcaMediaStreamEndpoint
Media stream endpoint descriptor. Collected by OcaMediaTransportApplication.
-
OcaMediaStreamEndpointID IDInternal
Internal ID.
-
OcaIODirection Direction
Input or output (input
->
samples flow into endpoint from network,output->samples
flow out of endpoint into network)
-
OcaList<OcaID16> StreamModeCapabilityIDs
Media stream mode capabilities of this endpoint. List of indexes into OcaMediaTransportApplication.MediaStreamModeCapabilities.
-
OcaBoolean ChannelMapDynamic
TRUE if and only if channel map may be modified at runtime.
-
OcaMultiMap<OcaUint16, OcaPortID> ChannelMap
Map of this endpoint’s signal channels to OCA Ports of the owning OcaMediaTransportApplication object. Each input endpoint channel may be mapped to zero or more output Ports; each output endpoint channel may be mapped to at most one input Port.
-
OcaDBFS AlignmentLevel
Alignment Level of the endpoint. The dBFS value is referenced to the endpoint’s fullscale value, not to Device’s internal fullscale value.
-
OcaMediaStreamMode CurrentStreamMode
Stream mode of current connection. If there is a no current connection, value is undefined.
-
OcaSecurityType SecurityType
Security type of this endpoint, if any.
-
OcaMediaStreamCastMode StreamCastMode
Unicast or multicast
-
OcaAdaptationData AdaptationData
Adaptation-specific connection data, e.g. IP addresses and ports of input and output endpoints. Specific media transport adaptations will define the fine-structure of this OcaBlob.
-
OcaMediaStreamEndpointID IDInternal
OcaMediaStreamEndpointStatus
-
struct OcaMediaStreamEndpointStatus
Current status of a media stream endpoint.
-
OcaMediaStreamEndpointState State
Endpoint state
-
OcaMediaStreamEndpointState State
OcaMediaStreamEndpointState
-
enum OcaMediaStreamEndpointState : uint8_t
State of a stream endpoint.
-
enumerator Unknown = 0
State of endpoint is unknown.
-
enumerator NotReady = 1
Endpoint is not ready for media transport.
-
enumerator Ready = 2
Endpoint is ready for media transport but is not connected to a stream.
-
enumerator Connected = 3
Endpoint has a connection but media stream data is not flowing.
-
enumerator Running = 4
Endpoint has a connection and media stream data is flowing.
-
enumerator ErrorHalt = 5
Data transfer has been halted due to errors.
-
enumerator Unknown = 0
OcaMediaStreamEndpointCommand
-
enum OcaMediaStreamEndpointCommand : uint8_t
Command values for OcaMediaTransportApplication.ApplyEndpointCommand(…)
-
enumerator None = 0
No-op. State shall not be changed.
-
enumerator SetReady = 1
Prepare Endpoint for connection. If the command succeeds, the resulting state shall be Ready.
-
enumerator Connect = 2
Connect to a stream. If the command succeeds, the resulting state shall be Connected.
-
enumerator ConnectAndStart = 3
Connect to a stream. If the command succeeds, the resulting state shall be Running.
-
enumerator Disconnect = 4
Disconnect from a stream. If the command succeeds, the resulting state shall be Ready.
-
enumerator StopAndDisconnect = 5
Stop media data transfer and disconnect from a running stream. If the command succeeds, the resulting state shall be Ready.
-
enumerator Start = 6
Commence media data transfer. If the command succeeds, the resulting state shall be Running.
-
enumerator Stop = 7
Stop media data transfer, but preserve the connection. If the command succeeds, the resulting state shall be Connected.
-
enumerator None = 0