Rialto  0.1
Rialto media pipeline API
Public Member Functions | Static Public Member Functions | List of all members
firebolt::rialto::IWebAudioPlayerFactory Class Referenceabstract

IWebAudioPlayer factory class, returns a concrete implementation of IWebAudioPlayer. More...

#include <IWebAudioPlayer.h>

Public Member Functions

virtual std::unique_ptr< IWebAudioPlayercreateWebAudioPlayer (std::weak_ptr< IWebAudioPlayerClient > client, const std::string &audioMimeType, const uint32_t priority, std::weak_ptr< const WebAudioConfig > config) const =0
 IWebAudioPlayer factory method, returns a concrete implementation of IWebAudioPlayer for playback of audio. More...
 

Static Public Member Functions

static std::shared_ptr< IWebAudioPlayerFactorycreateFactory ()
 Create a IWebAudioPlayerFactory instance. More...
 

Detailed Description

IWebAudioPlayer factory class, returns a concrete implementation of IWebAudioPlayer.

Member Function Documentation

◆ createFactory()

static std::shared_ptr<IWebAudioPlayerFactory> firebolt::rialto::IWebAudioPlayerFactory::createFactory ( )
static

Create a IWebAudioPlayerFactory instance.

Return values
thefactory instance or null on error.

◆ createWebAudioPlayer()

virtual std::unique_ptr<IWebAudioPlayer> firebolt::rialto::IWebAudioPlayerFactory::createWebAudioPlayer ( std::weak_ptr< IWebAudioPlayerClient client,
const std::string &  audioMimeType,
const uint32_t  priority,
std::weak_ptr< const WebAudioConfig config 
) const
pure virtual

IWebAudioPlayer factory method, returns a concrete implementation of IWebAudioPlayer for playback of audio.

Parameters
[in]clientThe Web Audio Player client
[in]audioMimeTypeThe audio encoding format, currently only "audio/x-raw" (PCM)
[in]priorityPriority value for this pipeline.
[in]configAdditional type dependent configuration data or nullptr

Some platforms have limited numbers of audio playbacks that can be mixed. The client application should therefore assign a priority to each audio player it creates, starting with priority 1 for the most important, priority 2 for the next etc. If a platform supports 'n' players, then any player with priority>n will appear to function normally by but the audio data will be silently discarded.

Return values
thenew Web Audio Player instance or null on error.

The documentation for this class was generated from the following file: