IEncoder Interface Reference

Generic encoder interface. More...

Inherits IDisposable.

Inherited by IEncoderDirect< B >.

Public Member Functions
ArraySegment< byte >	DequeueOutput (out FrameFlags flags)
	Returns next encoded data frame (if such output supported). More...
void	EndOfStream ()
	Forces an encoder to flush and produce frame with EndOfStream flag (in output queue). More...
I	GetPlatformAPI< I > ()
	Returns an platform-specific interface. More...

Properties
string	Error [get]
	If not null, the object is in invalid state. More...
Action< ArraySegment< byte >, FrameFlags >	Output [set]
	Set callback encoder calls on each encoded data frame (if such output supported). More...

Detailed Description

Generic encoder interface.

Depending on implementation, encoder should either call Output on eaach data frame or return next data frame in DequeueOutput() call.

Member Function Documentation

DequeueOutput()

ArraySegment<byte> DequeueOutput

(

out FrameFlags

flags

)

Returns next encoded data frame (if such output supported).

EndOfStream()

void EndOfStream

(

)

Forces an encoder to flush and produce frame with EndOfStream flag (in output queue).

GetPlatformAPI< I >()

I GetPlatformAPI< I >

(

)

Returns an platform-specific interface.

Type Constraints

I

:

class

Property Documentation

Error

string Error

get

If not null, the object is in invalid state.

Output

Action<ArraySegment<byte>, FrameFlags> Output

set

Set callback encoder calls on each encoded data frame (if such output supported).