Media Datatypes

OcaMediaPlayOption

enum OcaMediaPlayOption : uint8_t

Options for media playback

enumerator Normal = 0: Play until end of specified interval is reached or operation is halted by a controller action.

enumerator Autoclose = 1: Play until end of specified interval is reached or operation is halted by a controller action. If end of interval is reached, close session.

enumerator RepeatInterval = 2: Repeat playback of specified interval until operation is halted by a controller action.

OcaMediaRecorderPlayerState

enum OcaMediaRecorderPlayerState : uint8_t

State of OcaMediaRecorderPlayer object

enumerator Idle = 0: No media volume is open. Recorder/player is doing nothing.

enumerator Stopped = 1: Media volume is open but recorder/player is neither seeking, recording, nor playing.

enumerator Seeking = 2: Recorder/player is locating a designated position in a media file.

enumerator Recording = 3: Recorder/player is recording.

enumerator Playing = 4: Recorder/player is playing.

OcaMediaAccessMode

enum OcaMediaAccessMode : uint8_t

Media volume access mode: record or play.

enumerator None = 0: No media volume is open.

enumerator Play = 1: Media volume will be played.

enumerator Record = 2: Media volume will be recorded.

OcaMediaTrackFunction

using OcaMediaTrackFunction = OcaBitSet16 : Media track function. Controls handling of a track during OcaMediaRecorderPlayer operations.

OcaMediaVolumePositionType

enum OcaMediaVolumePositionType : uint16_t

Type of media position specified: samples or nanoseconds

enumerator Samples = 0: Position is specified as number of samples after start of this media volume.

enumerator Seconds = 1: Position is specified as time in floating-point seconds after start of this media volume.

OcaMediaVolumePosition

struct OcaMediaVolumePosition

Position within a media volume - samples or seconds.

OcaMediaVolumePositionType PositionType: What kind of position specification - samples or seconds.

OcaUint64 Position: Position - sample count or time in floating-point seconds after start of Media Volume.