os::MediaSyncStage Class Reference
[The Syllable Media API]

Media sync stage. More...

Inheritance diagram for os::MediaSyncStage:

List of all members.

Public Member Functions
	MediaSyncStage ()
	~MediaSyncStage ()
uint32	GetPhysicalType ()
	Physical type.
String	GetIdentifier ()
	Identifier.
uint32	GetInputCount ()
	Number of inputs.
uint32	GetInputFormatCount (uint32 nInput)
	Number of input formats.
MediaFormat_s	GetInputFormat (uint32 nInput, uint32 nNum)
	Input format.
uint32	GetOutputCount ()
	Number of outputs.
uint32	GetOutputFormatCount (uint32 nOutput)
MediaFormat_s	GetOutputFormat (uint32 nOutput)
	Output format.
status_t	GetPacket (uint32 nOutput, MediaPacket_s *psPacket)
	Read one packet.
status_t	Initialize ()
	Initializes the stage.
int	Run ()
	Run.
Static Public Member Functions
static MediaSyncStage *	CreateStage ()
	Creates a sync statge.
Classes
class	Private

---

Detailed Description

Description:

This media stage object manages the packet flow. It has two inputs and two outputs. The first one is for audio and the second one for video. The calls to GetOutputFormat() and GetIntputFormat() are always redirected to the previous/next stage.

Author:

Arno Klenke

---

Constructor & Destructor Documentation

MediaSyncStage::MediaSyncStage

(

)

MediaSyncStage::~MediaSyncStage

(

)

---

Member Function Documentation

uint32 MediaSyncStage::GetPhysicalType

(

)

[virtual]

Description:

Returns the physical of the stage.

Author:

Arno Klenke

Reimplemented from os::MediaStage.

String MediaSyncStage::GetIdentifier

(

)

[virtual]

Description:

Returns the identifier of the object.

Author:

Arno Klenke

Reimplemented from os::MediaStage.

uint32 MediaSyncStage::GetInputCount

(

)

[virtual]

Description:

Returns the number of inputs.

Author:

Arno Klenke

Reimplemented from os::MediaStage.

uint32 MediaSyncStage::GetInputFormatCount

(

uint32

nInput

)

[virtual]

Description:

Returns the number of formats of one input.

Parameters:

nInput

- The input.

Author:

Arno Klenke

Reimplemented from os::MediaStage.

MediaFormat_s MediaSyncStage::GetInputFormat	(	uint32	nInput,
		uint32	nNum
	)			[virtual]

Description:

Returns one input format.

Parameters:

	nInput	- The input.
	nNum	- Input format number.

Author:

Arno Klenke

Reimplemented from os::MediaStage.

uint32 MediaSyncStage::GetOutputCount

(

)

[virtual]

Description:

Returns the number of outputs.

Author:

Arno Klenke

Reimplemented from os::MediaStage.

uint32 os::MediaSyncStage::GetOutputFormatCount

(

uint32

nOutput

)

MediaFormat_s MediaSyncStage::GetOutputFormat

(

uint32

nOutput

)

[virtual]

Description:

Returns the format of one output.

Parameters:

nOutput

- The output.

Author:

Arno Klenke

Reimplemented from os::MediaStage.

status_t MediaSyncStage::GetPacket	(	uint32	nOutput,
		MediaPacket_s *	psPacket
	)			[virtual]

Description:

Reads one packet from the stage. The stage object will read data from the previous stages if necessary. You normally do not have to call this method directly because the MediaSyncStage takes care of this.

Parameters:

	nOutput	- The output.
	psPacket	- Pointer to a packet.

Author:

Arno Klenke

Reimplemented from os::MediaStage.

status_t MediaSyncStage::Initialize

(

)

[virtual]

Description:

This method has to be called for every stage object after you have connected all the stages.

Author:

Arno Klenke

Reimplemented from os::MediaStage.

int MediaSyncStage::Run

(

)

Description:

This method will fetch the audio and/or video packets from the connected inputs and codecs and pass them to the connected outputs at the right time. This method should be called from a separate thread and might block. It returns a value < 0 if there was an error. Otherwise it returns a value in msecs that tells the application when it has to call this function again.

Author:

Arno Klenke

MediaSyncStage * MediaSyncStage::CreateStage

(

)

[static]

Description:

Creates a sync stage.

Author:

Arno Klenke

---