fm.liveswitch.ProcessFramePolicy Enum Reference

The policy on how a media input should process the frame. More...

Public Member Functions
	ProcessFramePolicy (int value)
int	getAssignedValue ()

Static Public Member Functions
	[static initializer]
static ProcessFramePolicy	getByAssignedValue (int value)

Public Attributes
	Synchronous =(1)
	The media input will process the frame synchronously. More...
	Asynchronous =(2)
	The media input will process the frame asynchronously. More...

Detailed Description

The policy on how a media input should process the frame.

ProcessFramePolicy affects how media packets move from one processing element to the next in a media track. The default behaviour is synchronous, which is recommended for almost all applications. There are a few niche use cases (generally server-side) where a media track includes a branch with hundreds or thousands of leaves, in which case processing asynchronously (with accompanying thread-pool tuning) can eliminate the effects of favoritism in processing time towards the first leaves.

Constructor & Destructor Documentation

ProcessFramePolicy()

fm.liveswitch.ProcessFramePolicy.ProcessFramePolicy

(

int

value

)

Member Function Documentation

[static initializer]()

fm.liveswitch.ProcessFramePolicy.[static initializer]

static

getAssignedValue()

int fm.liveswitch.ProcessFramePolicy.getAssignedValue

(

)

getByAssignedValue()

static ProcessFramePolicy fm.liveswitch.ProcessFramePolicy.getByAssignedValue ( int  value )

static

Member Data Documentation

Asynchronous

fm.liveswitch.ProcessFramePolicy.Asynchronous =(2)

The media input will process the frame asynchronously.

Synchronous

fm.liveswitch.ProcessFramePolicy.Synchronous =(1)

The media input will process the frame synchronously.