StreamInfo Class Reference

Provides properties and operations that are common for all elementary streams. More...

Inherits Reference.

Inherited by AudioStreamInfo, and VideoStreamInfo.

List of all members.

Public Member Functions
virtual MediaType::Enum	mediaType () const =0
	Returns the stream media type.
virtual StreamType::Enum	streamType () const =0
	Returns the stream type.
virtual void	setStreamType (StreamType::Enum type)=0
	Sets the stream type.
virtual StreamSubType::Enum	streamSubType () const =0
	Returns the stream subtype.
virtual void	setStreamSubType (StreamSubType::Enum type)=0
	Sets the stream subtype.
virtual double	duration () const =0
	Returns the stream duration.
virtual void	setDuration (double duration)=0
	Sets the stream duration in seconds.
virtual int32_t	ID () const =0
	Returns the ID of the elementary stream.
virtual void	setID (int32_t id)=0
	Sets the ID of the elementary stream.
virtual int32_t	bitrate () const =0
	Returns the stream bitrate.
virtual void	setBitrate (int32_t bitrate)=0
	Sets the stream bitrate.
virtual int32_t	bitrateMode () const =0
	Returns the stream bitrate mode.
virtual void	setBitrateMode (int32_t bitrateMode)=0
	Sets the stream bitrate mode.
virtual StreamInfo *	clone () const =0
	Creates a copy of this object.
virtual bool_t	copyTo (StreamInfo *destination) const =0
	Copies the state of the current object to a destination object of the same type.
virtual void	reset ()=0
	Resets the stream information to its default state.
Protected Member Functions
	~StreamInfo ()
	This object can be destroyed only by its implementation.

---

Detailed Description

Provides properties and operations that are common for all elementary streams.

AudioStreamInfo and VideoStreamInfo inherit from this interface.

See also:

AudioStreamInfo

VideoStreamInfo

---

Constructor & Destructor Documentation

~StreamInfo

(

)

[protected]

This object can be destroyed only by its implementation.

The caller must use Reference::release.

See also:

Object Management

---

Member Function Documentation

virtual int32_t bitrate

(

)

const [pure virtual]

Returns the stream bitrate.

Returns:

bitrate in bits per second.

virtual int32_t bitrateMode

(

)

const [pure virtual]

Returns the stream bitrate mode.

Returns:

A BitrateMode::Enum constant.

virtual StreamInfo* clone

(

)

const [pure virtual]

Creates a copy of this object.

Returns:

A new StreamInfo object that has the same dynamic type as the cloned object.

When the object is cloned the full underlying object is copied.

For example if a StreamInfo object is actually an instance of AudioStreamInfo and is cloned, the new object is also an instance of AudioStreamInfo.

The caller is responsible for releasing the new object when it is not needed anymore.

See also:

Object Management

Implemented in VideoStreamInfo, and AudioStreamInfo.

virtual bool_t copyTo

(

StreamInfo *

destination

)

const [pure virtual]

Copies the state of the current object to a destination object of the same type.

The reference count of the source and the destination is not modified.

Parameters:

destination

[out] A pointer to the destination object

Returns:

TRUE The object state is copied, FALSE otherwise.

virtual double duration

(

)

const [pure virtual]

Returns the stream duration.

Returns:

duration in seconds

virtual int32_t ID

(

)

const [pure virtual]

Returns the ID of the elementary stream.

Returns:

stream id

virtual MediaType::Enum mediaType

(

)

const [pure virtual]

Returns the stream media type.

The media type of a StreamInfo object cannot be changed.

Returns:

media type

If the media type is MediaType.Audio this StreamInfo object can be safely cast to AudioStreamInfo.

If the media type is MediaType.Video this StreamInfo object can be safely cast to VideoStreamInfo.

virtual void reset

(

)

[pure virtual]

Resets the stream information to its default state.

The full underlying object is reset. The media type of the stream is never reset.

virtual void setBitrate

(

int32_t

bitrate

)

[pure virtual]

Sets the stream bitrate.

Parameters:

bitrate

the bitrate is expressed in bits per second.

virtual void setBitrateMode

(

int32_t

bitrateMode

)

[pure virtual]

Sets the stream bitrate mode.

Parameters:

bitrateMode

A BitrateMode::Enum constant.

virtual void setDuration

(

double

duration

)

[pure virtual]

Sets the stream duration in seconds.

Parameters:

duration

in seconds

virtual void setID

(

int32_t

id

)

[pure virtual]

Sets the ID of the elementary stream.

Parameters:

id	elementary stream id

virtual void setStreamSubType

(

StreamSubType::Enum

type

)

[pure virtual]

Sets the stream subtype.

Parameters:

type	stream subtype.

virtual void setStreamType

(

StreamType::Enum

type

)

[pure virtual]

Sets the stream type.

Parameters:

type	major stream type.

virtual StreamSubType::Enum streamSubType

(

)

const [pure virtual]

Returns the stream subtype.

Returns:

stream subtype

virtual StreamType::Enum streamType

(

)

const [pure virtual]

Returns the stream type.

Returns:

stream type