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

Media input stage. More...

Inheritance diagram for os::MediaInputStage:

List of all members.

Public Member Functions
	MediaInputStage ()
	~MediaInputStage ()
uint32	GetPhysicalType ()
	Physical type.
String	GetIdentifier ()
	Identifier.
bool	IsStream ()
	Stream.
uint32	GetTrackCount ()
	Number of tracks.
uint32	SelectTrack (uint32 nTrack)
	Select one track.
String	GetTitle ()
	Title of the file.
String	GetAuthor ()
	Author of the file.
String	GetAlbum ()
	Album.
String	GetComment ()
	Comment.
uint64	GetLength ()
	Length of the file.
uint64	GetCurrentPosition ()
	Current position.
uint64	Seek (uint64 nPosition)
	Seek.
uint32	GetOutputCount ()
	Number of outputs.
MediaFormat_s	GetOutputFormat (uint32 nOutput)
	Output format.
bool	HasInternalBuffer ()
	Internal buffer.
int	NextPacketStream ()
	Stream of the next available packet.
status_t	GetPacket (uint32 nOutput, MediaPacket_s *psPacket)
	Read one packet.
void	FreePacket (MediaPacket_s *psPacket)
	Frees one packet.
void	SetInput (MediaInput *pcInput)
	Assigns a media input object to the stage.
Static Public Member Functions
static MediaInputStage *	CreateStageForFile (String zFileName)
	Creates a stage object for a file.

---

Detailed Description

Description:

This media stage object represents an input.

Author:

Arno Klenke

---

Constructor & Destructor Documentation

MediaInputStage::MediaInputStage

(

)

MediaInputStage::~MediaInputStage

(

)

---

Member Function Documentation

uint32 MediaInputStage::GetPhysicalType

(

)

[virtual]

Description:

Returns the physical of the stage.

Author:

Arno Klenke

Reimplemented from os::MediaStage.

String MediaInputStage::GetIdentifier

(

)

[virtual]

Description:

Returns the identifier of the object.

Author:

Arno Klenke

Reimplemented from os::MediaStage.

bool MediaInputStage::IsStream

(

)

Description:

Returns whether the input is a stream and does not support seeking.

Author:

Arno Klenke

uint32 MediaInputStage::GetTrackCount

(

)

Description:

Returns the number of tracks.

Author:

Arno Klenke

uint32 MediaInputStage::SelectTrack

(

uint32

nTrack

)

Description:

Selects one track.

Parameters:

nTrack

- The track.

Author:

Arno Klenke

String MediaInputStage::GetTitle

(

)

Description:

Returns the title of the file or "".

Author:

Arno Klenke

String MediaInputStage::GetAuthor

(

)

Description:

Returns the author of the file or "".

Author:

Arno Klenke

String MediaInputStage::GetAlbum

(

)

Description:

Returns the album the file belongs to or "".

Author:

Arno Klenke

String MediaInputStage::GetComment

(

)

Description:

Returns a comment or "".

Author:

Arno Klenke

uint64 MediaInputStage::GetLength

(

)

Description:

Returns the length of the file in seconds.

Author:

Arno Klenke

uint64 MediaInputStage::GetCurrentPosition

(

)

Description:

Returns the current position.

Author:

Arno Klenke

uint64 MediaInputStage::Seek

(

uint64

nPosition

)

Description:

Seeks to a position in the file.

Parameters:

nPosition

- Position.

Author:

Arno Klenke

uint32 MediaInputStage::GetOutputCount

(

)

[virtual]

Description:

Returns the number of outputs.

Author:

Arno Klenke

Reimplemented from os::MediaStage.

MediaFormat_s MediaInputStage::GetOutputFormat

(

uint32

nOutput

)

[virtual]

Description:

Returns the format of one output.

Parameters:

nOutput

- The output.

Author:

Arno Klenke

Reimplemented from os::MediaStage.

bool MediaInputStage::HasInternalBuffer

(

)

[virtual]

Description:

Return whether the data pointer of the packets read with GetPacket() point to internal memory of the stage object.

Author:

Arno Klenke

Reimplemented from os::MediaStage.

int MediaInputStage::NextPacketStream

(

)

Description:

Returns the stream of the next available packet or -1.

Author:

Arno Klenke

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

void MediaInputStage::FreePacket

(

MediaPacket_s *

psPacket

)

[virtual]

Description:

Frees one packet. You normally do not have to call this method directly because the MediaSyncStage takes care of this.

Parameters:

psPacket

- Pointer to a packet.

Author:

Arno Klenke

Reimplemented from os::MediaStage.

void MediaInputStage::SetInput

(

MediaInput *

pcInput

)

Description:

Assigns a media input object to the stage.

Note:

The reference counter of the object is increased.

Parameters:

pcInput

- The object.

Author:

Arno Klenke

MediaInputStage * MediaInputStage::CreateStageForFile

(

String

zFileName

)

[static]

Description:

Creates a stage object for a file.

Parameters:

zFileName

- The filename.

Author:

Arno Klenke

---