Playback Controller Interface

Detailed Description

This optional host interface allows the plug-in to request playback state changes. The functions in this interface may be called concurrently, but not from render-threads. The host may choose to ignore any of these requests. The requests will typically be scheduled and executed with some delay. The current state of playback is transmitted via the companion API.
Host developer using C++ ARA Library can implement the ARA::Host::PlaybackControllerInterface. For plug-in developers this interface is wrapped by the ARA::PlugIn::HostPlaybackController.

Classes

struct  ARAPlaybackControllerInterface
 Host interface: playback controller. As with all host interfaces, the function pointers in this struct must remain valid until all document controllers on the plug-in side that use it have been destroyed. More...
 

Typedefs

typedef struct ARAPlaybackControllerHostRefMarkupType * ARAPlaybackControllerHostRef
 Reference to the host side representation of a playback controller (opaque to the plug-in).
 

Class Documentation

◆ ARAPlaybackControllerInterface

struct ARAPlaybackControllerInterface

Host interface: playback controller. As with all host interfaces, the function pointers in this struct must remain valid until all document controllers on the plug-in side that use it have been destroyed.

Public Attributes

ARASize structSize
 Size-based struct versioning - see Versioned structs.
 
void(* requestStartPlayback )(ARAPlaybackControllerHostRef controllerHostRef)
 Message to the host to start playback of our document.
 
void(* requestStopPlayback )(ARAPlaybackControllerHostRef controllerHostRef)
 Message to the host to stop playback of our document.
 
void(* requestSetPlaybackPosition )(ARAPlaybackControllerHostRef controllerHostRef, ARATimePosition timePosition)
 Message to the host to set the playback position of our document. Note that this may be called both when playing back or when stopped.
 
void(* requestSetCycleRange )(ARAPlaybackControllerHostRef controllerHostRef, ARATimePosition startTime, ARATimeDuration duration)
 Message to the host to set the playback cycle range of our document.
 
void(* requestEnableCycle )(ARAPlaybackControllerHostRef controllerHostRef, ARABool enable)
 Message to the host to enable or disable the playback cycle of our document.