This class implements the android library. More...

#include <ALibrary.h>

Inheritance diagram for Ocean::Media::Android::ALibrary:

Public Member Functions
MediumRef	newMedium (const std::string &url, bool useExclusive=false) override
	Creates a new medium by a given url.

MediumRef	newMedium (const std::string &url, const Medium::Type type, bool useExclusive=false) override
	Creates a new medium by a given url and an expected type.

RecorderRef	newRecorder (const Recorder::Type type) override
	Creates a new recorder specified by the recorder type.

Definitions	selectableMedia () const override
	Returns a list of selectable mediums.

Definitions	selectableMedia (const Medium::Type type) const override
	Returns a list of specific selectable mediums.

Medium::Type	supportedTypes () const override
	Returns the supported medium types.

Public Member Functions inherited from Ocean::Media::Library
const std::string &	name () const
	Returns the name of the library.

bool	supports (const Medium::Type type) const
	Returns whether the library supports a given medium type.

bool	notSupported (const std::string &extension) const
	Returns whether a given file extension is not supported by this library.

Static Public Member Functions
static bool	registerLibrary ()
	Registers this library at the global media manager.

static bool	unregisterLibrary ()
	Unregisters this library at the global media manager.

Static Public Member Functions inherited from Ocean::Media::Library
static std::string	convertDefinition (const Definition &definition)
	Converts a medium definition to one string.

static Definition	convertDefinition (const std::string &string)
	Converts a string to a medium definition.

Protected Member Functions
	ALibrary ()
	Creates a new ALibrary object.

	~ALibrary () override
	Destructs an ALibrary object.

MediumRef	newAudio (const std::string &url, bool useExclusive)
	Creates a new audio medium.

MediumRef	newLiveAudio (const std::string &url, bool useExclusive)
	Creates a new live audio medium.

MediumRef	newMicrophone (const std::string &url, bool useExclusive)
	Creates a new microphone medium.

bool	initializerAudioEngine ()
	Initializes the SL audio engine.

void	releaseAudioEngine ()
	Releases the SL audio engine.

MediumRef	newLiveVideo (const std::string &url, bool useExclusive) const
	Creates a new live video medium.

Protected Member Functions inherited from Ocean::Media::Library
	Library (const Library &library)=delete
	Disabled copy constructor.

	Library (const std::string &name, const unsigned int priority)
	Creates a new Library object.

virtual	~Library ()
	Destructs a library.

unsigned int	priority () const
	Returns the priority of this library.

void	registerNotSupportedExtension (const std::string &extension)
	Registers file extensions not supported by this library.

Library &	operator= (const Library &library)=delete
	Disabled copy operator.

Static Protected Member Functions
static MediumRef	newMovie (const std::string &url, bool useExclusive)
	Creates a new movie medium.

static LibraryRef	create ()
	Creates this library and returns it an object reference.

Protected Attributes
SLObjectItf	slEngine_ = nullptr
	The SL engine for all audio objects.

SLEngineItf	slEngineInterface_ = nullptr
	The SL engine interface for all audio objects.

NativeCameraLibrary::ScopedSubscription	nativeCameraLibrarySubscription_
	The subscription for the native camera library.

ALiveVideo::Devices	selectableLiveVideoDevices_
	The selectable live video devices.

NativeMediaLibrary::ScopedSubscription	nativeMediaLibrarySubscription_
	The subscription for the native media library.

Protected Attributes inherited from Ocean::Media::Library
std::string	libraryName
	The name of the library.

unsigned int	libraryPriority
	Priority of this library, the higher the value, the higher the priority.

Lock	lock
	Library lock.

Friends
class	Media::Manager

class	AAudio

class	ALiveAudio

class	ALiveVideo

class	AMovie

Additional Inherited Members
Public Types inherited from Ocean::Media::Library
using	Definitions = std::vector< Definition >
	Definition of a vector holding medium definition objects.

Protected Types inherited from Ocean::Media::Library
using	ExtensionSet = std::set< std::string >
	Definition of a set holding file extensions.

Detailed Description

This class implements the android library.

Constructor & Destructor Documentation

◆ ALibrary()

Ocean::Media::Android::ALibrary::ALibrary ( )

protected

Creates a new ALibrary object.

◆ ~ALibrary()

Ocean::Media::Android::ALibrary::~ALibrary ( )

overrideprotected

Destructs an ALibrary object.

Member Function Documentation

◆ create()

static LibraryRef Ocean::Media::Android::ALibrary::create ( )

staticprotected

Creates this library and returns it an object reference.

Returns: The new library object

◆ initializerAudioEngine()

bool Ocean::Media::Android::ALibrary::initializerAudioEngine ( )

protected

Initializes the SL audio engine.

Returns: True, if succeeded

◆ newAudio()

MediumRef Ocean::Media::Android::ALibrary::newAudio	(	const std::string &	url,
		bool	useExclusive
	)

protected

Creates a new audio medium.

Parameters

url	The URL of the audio medium to create
useExclusive	Determines whether the caller would like to use this medium exclusively

Returns: Reference of the new medium

◆ newLiveAudio()

MediumRef Ocean::Media::Android::ALibrary::newLiveAudio	(	const std::string &	url,
		bool	useExclusive
	)

protected

Creates a new live audio medium.

Parameters

url	The URL of the audio medium to create
useExclusive	Determines whether the caller would like to use this medium exclusively

Returns: Reference of the new medium

◆ newLiveVideo()

MediumRef Ocean::Media::Android::ALibrary::newLiveVideo	(	const std::string &	url,
		bool	useExclusive
	)		const

protected

Creates a new live video medium.

Parameters

url	The URL of the live video medium to create
useExclusive	Determines whether the caller would like to use this medium exclusively

Returns: Reference of the new medium

◆ newMedium() [1/2]

MediumRef Ocean::Media::Android::ALibrary::newMedium	(	const std::string &	url,
		bool	useExclusive = `false`
	)

overridevirtual

Creates a new medium by a given url.

See also: Library::newMedium().

Implements Ocean::Media::Library.

◆ newMedium() [2/2]

MediumRef Ocean::Media::Android::ALibrary::newMedium	(	const std::string &	url,
		const Medium::Type	type,
		bool	useExclusive = `false`
	)

overridevirtual

Creates a new medium by a given url and an expected type.

See also: Library::newMedium().

Implements Ocean::Media::Library.

◆ newMicrophone()

MediumRef Ocean::Media::Android::ALibrary::newMicrophone	(	const std::string &	url,
		bool	useExclusive
	)

protected

Creates a new microphone medium.

Parameters

url	The URL of the audio medium to create
useExclusive	Determines whether the caller would like to use this medium exclusively

Returns: Reference of the new medium

◆ newMovie()

static MediumRef Ocean::Media::Android::ALibrary::newMovie	(	const std::string &	url,
		bool	useExclusive
	)

staticprotected

Creates a new movie medium.

Parameters

url	The URL of the movie medium to create
useExclusive	Determines whether the caller would like to use this medium exclusively

Returns: Reference of the new medium

◆ newRecorder()

RecorderRef Ocean::Media::Android::ALibrary::newRecorder ( const Recorder::Type type )

overridevirtual

Creates a new recorder specified by the recorder type.

See also: Library::newRecorder().

Implements Ocean::Media::Library.

◆ registerLibrary()

static bool Ocean::Media::Android::ALibrary::registerLibrary ( )

static

Registers this library at the global media manager.

With each register call, the reference counter for a specific library will be incremented. Each call to registerLibrary() needs to be balanced with a corresponding call of unregisterLibrary() before shutting down.

Returns: True, if the library has not been registered before

See also: Manager, unregisterLibrary()

◆ releaseAudioEngine()

void Ocean::Media::Android::ALibrary::releaseAudioEngine ( )

protected

Releases the SL audio engine.

◆ selectableMedia() [1/2]

Definitions Ocean::Media::Android::ALibrary::selectableMedia ( ) const

overridevirtual

Returns a list of selectable mediums.

See also: Library::selectableMedia().

Reimplemented from Ocean::Media::Library.

◆ selectableMedia() [2/2]

Definitions Ocean::Media::Android::ALibrary::selectableMedia ( const Medium::Type type ) const

overridevirtual

Returns a list of specific selectable mediums.

See also: Library::selectableMedia().

Reimplemented from Ocean::Media::Library.

◆ supportedTypes()

Medium::Type Ocean::Media::Android::ALibrary::supportedTypes ( ) const

overridevirtual

Returns the supported medium types.

See also: Library::supportedTypes().

Reimplemented from Ocean::Media::Library.

◆ unregisterLibrary()

static bool Ocean::Media::Android::ALibrary::unregisterLibrary ( )

static

Unregisters this library at the global media manager.

With each unregister call, the reference counter for a specific library will be decremented and removed from the system if the counter reaches zero. Each call to registerLibrary() needs to be balanced with a corresponding call of unregisterLibrary() before shutting down.

Returns: True, if the library was actually removed from the system (as the reference counter reached zero); False, if the library is still used by someone else

See also: registerLibrary().

Friends And Related Symbol Documentation

◆ AAudio

friend class AAudio

friend

◆ ALiveAudio

friend class ALiveAudio

friend

◆ ALiveVideo

friend class ALiveVideo

friend

◆ AMovie

friend class AMovie

friend

◆ Media::Manager

friend class Media::Manager

friend

Field Documentation

◆ nativeCameraLibrarySubscription_

NativeCameraLibrary::ScopedSubscription Ocean::Media::Android::ALibrary::nativeCameraLibrarySubscription_

protected

The subscription for the native camera library.

◆ nativeMediaLibrarySubscription_

NativeMediaLibrary::ScopedSubscription Ocean::Media::Android::ALibrary::nativeMediaLibrarySubscription_

protected

The subscription for the native media library.

◆ selectableLiveVideoDevices_

ALiveVideo::Devices Ocean::Media::Android::ALibrary::selectableLiveVideoDevices_

mutableprotected

The selectable live video devices.

◆ slEngine_

SLObjectItf Ocean::Media::Android::ALibrary::slEngine_ = nullptr

protected

The SL engine for all audio objects.

◆ slEngineInterface_

SLEngineItf Ocean::Media::Android::ALibrary::slEngineInterface_ = nullptr

protected

The SL engine interface for all audio objects.

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

ALibrary.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ALibrary()

◆ ~ALibrary()

Member Function Documentation

◆ create()

◆ initializerAudioEngine()

◆ newAudio()

◆ newLiveAudio()

◆ newLiveVideo()

◆ newMedium() [1/2]

◆ newMedium() [2/2]

◆ newMicrophone()

◆ newMovie()

◆ newRecorder()

◆ registerLibrary()

◆ releaseAudioEngine()

◆ selectableMedia() [1/2]

◆ selectableMedia() [2/2]

◆ supportedTypes()

◆ unregisterLibrary()

Friends And Related Symbol Documentation

◆ AAudio

◆ ALiveAudio

◆ ALiveVideo

◆ AMovie

◆ Media::Manager

Field Documentation

◆ nativeCameraLibrarySubscription_

◆ nativeMediaLibrarySubscription_

◆ selectableLiveVideoDevices_

◆ slEngine_

◆ slEngineInterface_