2.5.12 IDeckLinkAudioInputPacket Interface

class IDeckLinkAudioInputPacket

The IDeckLinkAudioInputPacket interface represents a packet of audio which has been captured by an IDeckLinkInput interface.

Objects with an IDeckLinkAudioInputPacket interface are passed to the IDeckLinkInputCallback::VideoInputFrameArrived() callback.

Audio channel samples are interleaved into a sample frame and sample frames are contiguous.

Related Interfaces

Interface	Interface ID	Description
IDeckLinkInputCallback	IID_IDeckLinkInputCallback	An IDeckLinkAudioInputPacket object interface is passed to IDeckLinkInputCallback::VideoInputFrameArrived()

2.5.12.1 IDeckLinkAudioInputPacket::GetSampleFrameCount method

long IDeckLinkAudioInputPacket::GetSampleFrameCount();

The GetSampleFrameCount method returns the number of sample frames in the packet.

Returns:

Audio packet size in sample frames

2.5.12.2 IDeckLinkAudioInputPacket::GetBytes method

HRESULT IDeckLinkAudioInputPacket::GetBytes(void **buffer);

The GetBytes method returns a pointer to the data buffer of the audio packet.

Parameters:

buffer – Pointer to audio data - only valid while object remains valid

Return values:

• E_FAIL – Failure

• S_OK – Success

2.5.12.3 IDeckLinkAudioInputPacket::GetPacketTime method

HRESULT IDeckLinkAudioInputPacket::GetPacketTime(BMDTimeValue *packetTime, BMDTimeScale timeScale);

The GetPacketTime method returns the time stamp of the video frame corresponding to the specified audio packet.

Parameters:

• packetTime – Video frame time corresponding to audio packet in timeScale units

• timeScale – Time scale for time stamp to be returned

Return values:

• E_FAIL – Failure

• S_OK – Success