Description

Vuo AV Foundation Player interface implementation.

Copyright: Copyright © 2012–2021 Kosada Incorporated. This code may be modified and distributed under the terms of the MIT License. For more information, see https://vuo.org/license.

Definition in file VuoAvPlayerInterface.h.

Typedefs
typedef void *	VuoAvPlayerObjPtr
	Pointer to a VuoAvPlayerObject, used to play videos using AV Foundation. More...

Functions
VuoAvPlayerObjPtr	VuoAvPlayer_make (const char *url)
	Create a new VuoAvPlayer instance. More...

void	VuoAvPlayer_release (VuoAvPlayerObjPtr player)
	Release a VuoAvPlayer instance. More...

bool	VuoAvPlayer_isReady (VuoAvPlayerObjPtr player)
	Is the decoder ready to begin playback? More...

void	VuoAvPlayer_setPlaybackRate (VuoAvPlayerObjPtr player, VuoReal rate)
	Set the rate at which video plays (forwards or backwards). More...

double	VuoAvPlayer_getFrameRate (VuoAvPlayerObjPtr player)
	The average framerate. More...

bool	VuoAvPlayer_seekToSecond (VuoAvPlayerObjPtr player, VuoReal second, VuoVideoFrame *frame) VuoWarnUnusedResult
	Seek playhead to second. More...

void	VuoAvPlayer_setOnPlaybackReadyCallbackObject (VuoAvPlayerObjPtr player, void(callback)(void id, bool canPlayMedia), void *id)
	Set the VuoVideoPlayer instance to call OnDecoderPlaybackReady. More...

bool	VuoAvPlayer_nextVideoFrame (VuoAvPlayerObjPtr player, VuoVideoFrame *videoFrame) VuoWarnUnusedResult
	Get the next video frame (forwards or backwards). More...

bool	VuoAvPlayer_nextAudioFrame (VuoAvPlayerObjPtr player, VuoAudioFrame *audioFrame) VuoWarnUnusedResult
	Get the next audio frame. More...

VuoReal	VuoAvPlayer_getCurrentTimestamp (VuoAvPlayerObjPtr player)
	Return the last decoded and accessed timestamp. More...

VuoReal	VuoAvPlayer_getDuration (VuoAvPlayerObjPtr player)
	Get the duration of this video. More...

bool	VuoAvPlayer_canPlayAudio (VuoAvPlayerObjPtr player)
	Return true if the asset either has no audio, or it does and can play it. More...

unsigned int	VuoAvPlayer_audioChannelCount (VuoAvPlayerObjPtr player)
	Return the number of audio channels available. More...

Typedef Documentation

◆ VuoAvPlayerObjPtr

typedef void* VuoAvPlayerObjPtr

Pointer to a VuoAvPlayerObject, used to play videos using AV Foundation.

Definition at line 24 of file VuoAvPlayerInterface.h.

Function Documentation

◆ VuoAvPlayer_audioChannelCount()

unsigned int VuoAvPlayer_audioChannelCount ( VuoAvPlayerObjPtr player )

Return the number of audio channels available.

Definition at line 103 of file VuoAvPlayerInterface.m.

◆ VuoAvPlayer_canPlayAudio()

bool VuoAvPlayer_canPlayAudio ( VuoAvPlayerObjPtr player )

Return true if the asset either has no audio, or it does and can play it.

Definition at line 97 of file VuoAvPlayerInterface.m.

◆ VuoAvPlayer_getCurrentTimestamp()

VuoReal VuoAvPlayer_getCurrentTimestamp ( VuoAvPlayerObjPtr player )

Return the last decoded and accessed timestamp.

Definition at line 85 of file VuoAvPlayerInterface.m.

◆ VuoAvPlayer_getDuration()

VuoReal VuoAvPlayer_getDuration ( VuoAvPlayerObjPtr player )

Get the duration of this video.

Definition at line 91 of file VuoAvPlayerInterface.m.

◆ VuoAvPlayer_getFrameRate()

double VuoAvPlayer_getFrameRate ( VuoAvPlayerObjPtr player )

The average framerate.

Definition at line 55 of file VuoAvPlayerInterface.m.

◆ VuoAvPlayer_isReady()

bool VuoAvPlayer_isReady ( VuoAvPlayerObjPtr player )

Is the decoder ready to begin playback?

Definition at line 43 of file VuoAvPlayerInterface.m.

◆ VuoAvPlayer_make()

VuoAvPlayerObjPtr VuoAvPlayer_make ( const char * url )

Create a new VuoAvPlayer instance.

Definition at line 22 of file VuoAvPlayerInterface.m.

◆ VuoAvPlayer_nextAudioFrame()

bool VuoAvPlayer_nextAudioFrame	(	VuoAvPlayerObjPtr	player,
		VuoAudioFrame *	audioFrame
	)

Get the next audio frame.

Definition at line 79 of file VuoAvPlayerInterface.m.

◆ VuoAvPlayer_nextVideoFrame()

bool VuoAvPlayer_nextVideoFrame	(	VuoAvPlayerObjPtr	player,
		VuoVideoFrame *	videoFrame
	)

Get the next video frame (forwards or backwards).

Definition at line 73 of file VuoAvPlayerInterface.m.

◆ VuoAvPlayer_release()

void VuoAvPlayer_release ( VuoAvPlayerObjPtr player )

Release a VuoAvPlayer instance.

Definition at line 37 of file VuoAvPlayerInterface.m.

◆ VuoAvPlayer_seekToSecond()

bool VuoAvPlayer_seekToSecond	(	VuoAvPlayerObjPtr	player,
		VuoReal	second,
		VuoVideoFrame *	frame
	)

Seek playhead to second.

Definition at line 61 of file VuoAvPlayerInterface.m.

◆ VuoAvPlayer_setOnPlaybackReadyCallbackObject()

void VuoAvPlayer_setOnPlaybackReadyCallbackObject	(	VuoAvPlayerObjPtr	player,
		void()(void id, bool canPlayMedia)	callback,
		void *	id
	)

Set the VuoVideoPlayer instance to call OnDecoderPlaybackReady.

Definition at line 67 of file VuoAvPlayerInterface.m.

◆ VuoAvPlayer_setPlaybackRate()

void VuoAvPlayer_setPlaybackRate	(	VuoAvPlayerObjPtr	player,
		VuoReal	rate
	)

Set the rate at which video plays (forwards or backwards).

Definition at line 49 of file VuoAvPlayerInterface.m.