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

Media Manager. More...

List of all members.

Public Member Functions

 MediaManager ()
 Construct one media manager.
virtual ~MediaManager ()
 Destruct one media manager.
void AddRef ()
void Put ()
 Decrements the reference counter of the instance.
bool IsValid ()
 Valid.
Messenger GetServerLink ()
 Server link.
MediaInputGetBestInput (String zFileName)
 Return a matching input object.
MediaInputGetDefaultInput ()
 Return default input.
void SetDefaultInput (os::String zIdentifier)
 Set default input.
MediaInputGetInput (uint32 nIndex)
 Return one input.
MediaCodecGetBestCodec (MediaFormat_s sInternalFormat, MediaFormat_s sExternalFormat, bool bEncode)
 Return a matching codec.
MediaCodecGetCodec (uint32 nIndex)
 Return one codec.
MediaOutputGetBestOutput (String zFileName, String zIdentifier)
 Return a matching output.
MediaOutputGetDefaultAudioOutput ()
 Return default audio output.
void SetDefaultAudioOutput (os::String zIdentifier)
 Set default audio output.
MediaOutputGetDefaultVideoOutput ()
 Return default video output.
void SetDefaultVideoOutput (os::String zIdentifier)
 Set default video output.
MediaOutputGetOutput (uint32 nIndex)
 Return one output.
virtual void _reserved1 ()
virtual void _reserved2 ()
virtual void _reserved3 ()
virtual void _reserved4 ()
virtual void _reserved5 ()
virtual void _reserved6 ()
virtual void _reserved7 ()
virtual void _reserved8 ()
virtual void _reserved9 ()
virtual void _reserved10 ()

Static Public Member Functions

static MediaManagerGetInstance ()
 Return instance.
static MediaManagerGet ()
 Provides access to the MediaManager class.

Classes

class  Private


Detailed Description

Description:
The Media Manager class is used to allocate input / output and codec objects.
Author:
Arno Klenke


Constructor & Destructor Documentation

MediaManager::MediaManager (  ) 

Description:
Constructs a new media manager and loads all plugins.
Note:
Should never be called! Use the Get() method instead.
Author:
Arno Klenke

MediaManager::~MediaManager (  )  [virtual]

Description:
Destructs a media manager and unloads all plugins. WARNING: This call is deprecated. Always use the Get() and Put() methods!
Author:
Arno Klenke


Member Function Documentation

void MediaManager::AddRef (  ) 

MediaManager * MediaManager::GetInstance (  )  [static]

Description:
Returns the current instance of the media manager. WARNING: This call is deprecated. Always use the Get() and Put() methods!
See also:
Get(), Put()
Author:
Arno Klenke

MediaManager * MediaManager::Get (  )  [static]

Description:
Creates a new media manager if it does not exist. Otherwise return a pointer to the current one.
Note:
Make sure you call Put() afterwards. If the creation fails, an exception will be thrown.
See also:
Put()
Author:
Arno Klenke ([email protected])

void MediaManager::Put (  ) 

Description:
Decrements the reference counter of the instance.
Note:
Make sure that you do one call to this method for every Get() call in your appliction.
See also:
Get()
Author:
Arno Klenke ([email protected])

bool MediaManager::IsValid (  ) 

Description:
Returns whether the created media manager is valid.
Author:
Arno Klenke

Messenger MediaManager::GetServerLink (  ) 

Description:
Returns a link to the media server.
Note:
Normal applications should not use this!
Author:
Arno Klenke

MediaInput * MediaManager::GetBestInput ( String  zFileName  ) 

Description:
Returns a matching input object for the requested device / file. Returns NULL if no input object could be found.
Note:
This only works for inputs which require a filename! To get other inputs you have to use the GetInput() or GetDefaultInput() method.
Parameters:
zFileName - Filename of the device / file.
Author:
Arno Klenke

MediaInput * MediaManager::GetDefaultInput (  ) 

Description:
Returns the default input or NULL if there is no default output.
Author:
Arno Klenke

void MediaManager::SetDefaultInput ( os::String  zIdentifier  ) 

Description:
Sets the default input.
Note:
Applications will probably never call this.
Parameters:
zIdentifier - Identifier of the input.
Author:
Arno Klenke

MediaInput * MediaManager::GetInput ( uint32  nIndex  ) 

Description:
Returns the input specified by the nIndex parameter or NULL if this index is invalid.
Parameters:
nIndex - Index of the input.
Author:
Arno Klenke

MediaCodec * MediaManager::GetBestCodec ( MediaFormat_s  sInternal,
MediaFormat_s  sExternal,
bool  bEncode 
)

Description:
Returns a matching codec for the requested codec format. Returns NULL if no codec could be found.
Parameters:
sInternal - Requested internal format of the codec.
sExternal - Requested external format of the codec.
bEncode - If the codec should be used for encoding.
Author:
Arno Klenke

MediaCodec * MediaManager::GetCodec ( uint32  nIndex  ) 

Description:
Returns the codec specified by the nIndex parameter or NULL if this index is invalid.
Parameters:
nIndex - Index of the input.
Author:
Arno Klenke

MediaOutput * MediaManager::GetBestOutput ( String  zFileName,
String  zIdentifier 
)

Description:
Returns a matching output for the identifier. Returns NULL if no output could be found.
Parameters:
zFileName - File or device to where the data should be written.
zIdentifier - Identifier of the output
Author:
Arno Klenke

MediaOutput * MediaManager::GetDefaultAudioOutput (  ) 

Description:
Returns the default audio output or NULL if there is no default audio output.
Author:
Arno Klenke

void MediaManager::SetDefaultAudioOutput ( os::String  zIdentifier  ) 

Description:
Sets the default audio output.
Note:
Applications will probably never call this.
Parameters:
zIdentifier - Identifier of the output.
Author:
Arno Klenke

MediaOutput * MediaManager::GetDefaultVideoOutput (  ) 

Description:
Returns the default video output or NULL if there is no default video output.
Author:
Arno Klenke

void MediaManager::SetDefaultVideoOutput ( os::String  zIdentifier  ) 

Description:
Sets the default video output.
Note:
Applications will probably never call this.
Parameters:
zIdentifier - Identifier of the output.
Author:
Arno Klenke

MediaOutput * MediaManager::GetOutput ( uint32  nIndex  ) 

Description:
Returns the output specified by the nIndex parameter or NULL if this index is invalid.
Parameters:
nIndex - Index of the input.
Author:
Arno Klenke

void MediaManager::_reserved1 (  )  [virtual]

void MediaManager::_reserved2 (  )  [virtual]

void MediaManager::_reserved3 (  )  [virtual]

void MediaManager::_reserved4 (  )  [virtual]

void MediaManager::_reserved5 (  )  [virtual]

void MediaManager::_reserved6 (  )  [virtual]

void MediaManager::_reserved7 (  )  [virtual]

void MediaManager::_reserved8 (  )  [virtual]

void MediaManager::_reserved9 (  )  [virtual]

void MediaManager::_reserved10 (  )  [virtual]


Generated on Sat May 9 22:49:20 2009 for Syllable Media API by  doxygen 1.5.1