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

Media Output. More...

List of all members.

Public Member Functions
	MediaOutput ()
virtual String	GetIdentifier ()
	Identifier.
virtual uint32	GetPhysicalType ()
	Physical type.
virtual View *	GetConfigurationView ()
	Configuration view.
virtual bool	FileNameRequired ()
	Filename required.
virtual status_t	Open (String zFileName)
	Open output.
virtual void	Close ()
	Close the output.
virtual void	Clear ()
	Clear the output.
virtual uint32	GetOutputFormatCount ()
	Format Count.
virtual MediaFormat_s	GetOutputFormat (uint32 nIndex)
	Return one supported format.
virtual uint32	GetSupportedStreamCount ()
	Supported stream count.
virtual status_t	AddStream (String zName, MediaFormat_s sFormat)
	Add one stream.
virtual View *	GetVideoView (uint32 nStream)
	Return a view with the video.
virtual void	UpdateView (uint32 nStream)
	Update video view.
virtual status_t	WritePacket (uint32 nStream, MediaPacket_s *psPacket)
	Write media data.
virtual uint64	GetDelay (bool bNonSharedOnly=false)
	Delay.
virtual uint64	GetBufferSize (bool bNonSharedOnly=false)
	Returns the size of the buffer.
Protected Member Functions
virtual	~MediaOutput ()

---

Detailed Description

Description:

The Media Output class can be used to output audio or video data. It should only be used together with the Media Manager class.

Author:

Arno Klenke

---

Constructor & Destructor Documentation

MediaOutput::~MediaOutput

(

)

[protected, virtual]

MediaOutput::MediaOutput

(

)

---

Member Function Documentation

String MediaOutput::GetIdentifier

(

)

[virtual]

Description:

Returns the identifier of the object.

Author:

Arno Klenke

uint32 MediaOutput::GetPhysicalType

(

)

[virtual]

Description:

Returns the physical type of the device.

Author:

Arno Klenke

View * MediaOutput::GetConfigurationView

(

)

[virtual]

Description:

Returns a view which includes configuration controls or NULL if this is not supported.

Author:

Arno Klenke

bool MediaOutput::FileNameRequired

(

)

[virtual]

Description:

Returns true if a filename for the Open() method is required.

Author:

Arno Klenke

status_t MediaOutput::Open

(

String

zFileName

)

[virtual]

Description:

Opens the output with the provided filename.

Parameters:

zFileName

- Filename or identifier of the output if FileNameRequired() returns true.

Author:

Arno Klenke

void MediaOutput::Close

(

)

[virtual]

Description:

Closes the output. Should be called when the output is no longer used.

Author:

Arno Klenke

void MediaOutput::Clear

(

)

[virtual]

Description:

Clears all caches of the output.

Author:

Arno Klenke

uint32 MediaOutput::GetOutputFormatCount

(

)

[virtual]

Description:

Returns the number of supported output formats. The Open() method needs to be called before.

Author:

Arno Klenke

MediaFormat_s MediaOutput::GetOutputFormat

(

uint32

nIndex

)

[virtual]

Description:

Returns one supported media format.

Parameters:

nIndex

- Index of the format.

Author:

Arno Klenke

uint32 MediaOutput::GetSupportedStreamCount

(

)

[virtual]

Description:

Returns the number of supported streams.

Author:

Arno Klenke

status_t MediaOutput::AddStream	(	String	zName,
		MediaFormat_s	sFormat
	)			[virtual]

Description:

Adds one stream to the output. The stream index is 0 for the first stream. Returns 0 if successful.

Parameters:

	zName	- Name of the stream.
	sFormat	- Requested format.

Author:

Arno Klenke

View * MediaOutput::GetVideoView

(

uint32

nStream

)

[virtual]

Description:

Returns a view with the displayed video or NULL if this feature is not supported.

Note:

The view will have the size of the input video stream first.

Parameters:

nStream

- Stream index.

Author:

Arno Klenke

void MediaOutput::UpdateView

(

uint32

nStream

)

[virtual]

Description:

Updates the video view. Needs to be called when the view position on the screen changes ( e.g. when the window with the view is moved ).

Parameters:

nStream

- Stream index.

Author:

Arno Klenke

status_t MediaOutput::WritePacket	(	uint32	nStream,
		MediaPacket_s *	psPacket
	)			[virtual]

Description:

Writes one packet of media data.

Note:

Use GetDelay() to look how long it will take until the data is played.

Parameters:

	nStream	- Stream index.
	psPacket	- Media packet with the data.

Author:

Arno Klenke

uint64 MediaOutput::GetDelay

(

bool

bNonSharedOnly = false

)

[virtual]

Description:

Returns the time it takes till the last queued packet has been played.

Parameters:

bNonSharedOnly

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

Author:

Arno Klenke

uint64 MediaOutput::GetBufferSize

(

bool

bNonSharedOnly = false

)

[virtual]

Description:

Returns the size of the output buffer in msecs.

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

---