DSGetClock

Synopsis

int32 DSGetClock (DSStreamCBPtr streamCBPtr, uint32* streamClock)

Description

Returns the value of the DataStreamer clock. The current clock time is calculated as the difference between the Portfolio audio clock and the current stream clock offset.

Clock time in the DataStreamer is measured in standard Portfolio audio clock ticks (the DataStreamer does not change the rate of the audio clock or the duration of audio ticks). Since the DataStreamer does not own the audio clock, however, external tasks can affect the DataStreamer clock by altering the state of the audio clock.

Arguments

streamCBPtr: Pointer to the stream context block.

streamClock: Pointer to where stream clock value is returned.

Return Value

Value: Error Condition

kDSNoErr: None

kDSClockNotValidErr: Current clock value not valid (the STRM_CLOCK_VALID flag of the streamFlags field in the specified stream context block is set to FALSE)

Associated Files