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

Media output stage. More...

Inheritance diagram for os::MediaOutputStage:

List of all members.

Public Member Functions
	MediaOutputStage ()
	~MediaOutputStage ()
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.
status_t	Initialize ()
	Initializes the stage.
status_t	GetPacket (uint32 nOutput, MediaPacket_s *psPacket)
	Read one packet.
uint64	GetDelay (bool bNonSharedOnly=false)
	Delay.
uint64	GetBufferSize (bool bNonSharedOnly=false)
	Buffer size.
os::View *	GetView ()
void	SetOutput (MediaOutput *pcOutput)
	Assigns a media output object to the stage.
Static Public Member Functions
static MediaOutputStage *	CreateDefaultAudioOutputStage (os::String zParameters)
	Creates a output stage for the default audio output.
static MediaOutputStage *	CreateDefaultVideoOutputStage (os::String zParameters)
	Creates a output stage for the default video output.

---

Detailed Description

Description:

This media stage object represents an output

Author:

Arno Klenke

---

Constructor & Destructor Documentation

MediaOutputStage::MediaOutputStage

(

)

MediaOutputStage::~MediaOutputStage

(

)

---

Member Function Documentation

uint32 MediaOutputStage::GetPhysicalType

(

)

[virtual]

Description:

Returns the physical of the stage.

Author:

Arno Klenke

Reimplemented from os::MediaStage.

String MediaOutputStage::GetIdentifier

(

)

[virtual]

Description:

Returns the identifier of the object.

Author:

Arno Klenke

Reimplemented from os::MediaStage.

uint32 MediaOutputStage::GetInputCount

(

)

[virtual]

Description:

Returns the number of inputs.

Author:

Arno Klenke

Reimplemented from os::MediaStage.

uint32 MediaOutputStage::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 MediaOutputStage::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.

status_t MediaOutputStage::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.

status_t MediaOutputStage::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.

uint64 MediaOutputStage::GetDelay

(

bool

bNonSharedOnly = false

)

[virtual]

Description:

Returns the delay of the stage.

Parameters:

bNonSharedOnly

- If the output has shared and non-shared buffers then true will return the buffer size of the non-shared buffer only. Otherwise the complete buffer size will be returned.

Author:

Arno Klenke

Reimplemented from os::MediaStage.

uint64 MediaOutputStage::GetBufferSize

(

bool

bNonSharedOnly = false

)

[virtual]

Description:

Returns the buffer size of the stage.

Parameters:

bNonSharedOnly

- If the output has shared and non-shared buffers then true will return the buffer size of the non-shared buffer only. Otherwise the complete buffer size will be returned.

Author:

Arno Klenke

Reimplemented from os::MediaStage.

os::View * MediaOutputStage::GetView

(

)

void MediaOutputStage::SetOutput

(

MediaOutput *

pcOutput

)

Description:

Assigns a media output object to the stage.

Note:

The reference counter of the object is increased.

Parameters:

pcOutput

- The object.

Author:

Arno Klenke

MediaOutputStage * MediaOutputStage::CreateDefaultAudioOutputStage

(

os::String

zParameters

)

[static]

Description:

Creates a output stage for the default audio output.

Author:

Arno Klenke

MediaOutputStage * MediaOutputStage::CreateDefaultVideoOutputStage

(

os::String

zParameters

)

[static]

Description:

Creates a output stage for the default video output.

Author:

Arno Klenke

---