Async::AudioContainerOpus Class Reference

#include <AsyncAudioContainerOpus.h>

Inheritance diagram for Async::AudioContainerOpus:

Public Member Functions
	AudioContainerOpus (void)
	Default constructor.
virtual	~AudioContainerOpus (void)
	Destructor.
virtual const char *	mediaType (void) const
	Retrieve the media type for the audio container.
virtual const char *	filenameExtension (void) const
	Get the standard filename extension for the audio container.
virtual void	endStream (void)
	Indicate to the container that the stream has ended.
virtual size_t	headerSize (void) const
	Get the size of the header for this container.
virtual const char *	header (void)
	Get the header data.
Public Member Functions inherited from Async::AudioContainer
	AudioContainer (void)
	Default constructor.
	AudioContainer (const AudioContainer &)=delete
	Disable copy constructor.
AudioContainer &	operator= (const AudioContainer &)=delete
	Disable assignment operator.
virtual	~AudioContainer (void)
	Destructor.
virtual void	setRealtime (void)
	Indicate to the container that realtime operation is desired.
Public Member Functions inherited from Async::AudioSink
	AudioSink (void)
	Default constuctor.
virtual	~AudioSink (void)
	Destructor.
bool	registerSource (AudioSource *source)
	Register an audio source to provide samples to this sink.
void	unregisterSource (void)
	Unregister the previously registered audio source.
bool	isRegistered (void) const
	Check if an audio source has been registered.
AudioSource *	source (void) const
	Get the registered audio source.
virtual int	writeSamples (const float *samples, int count)
	Write samples into this audio sink.
virtual void	flushSamples (void)
	Tell the sink to flush the previously written samples.

Static Public Attributes
static constexpr const char *	OBJNAME = "opus"
	The name of this class when used by the object factory.

Additional Inherited Members
Public Attributes inherited from Async::AudioContainer
sigc::signal< void, const char *, size_t >	writeBlock
	A signal that is emitted when a block is ready to be written.
Protected Member Functions inherited from Async::AudioSink
void	sourceResumeOutput (void)
	Tell the source that we are ready to accept more samples.
void	sourceAllSamplesFlushed (void)
	Tell the source that all samples have been flushed.
bool	setHandler (AudioSink *handler)
	Setup another sink to handle the incoming audio.
void	clearHandler (void)
	Clear a handler that was previously setup with setHandler.
AudioSink *	handler (void) const

Detailed Description

Definition at line 125 of file AsyncAudioContainerOpus.h.

Constructor & Destructor Documentation

AudioContainerOpus()

Async::AudioContainerOpus::AudioContainerOpus

(

void

)

Default constructor.

~AudioContainerOpus()

virtual Async::AudioContainerOpus::~AudioContainerOpus ( void )

virtual

Destructor.

Member Function Documentation

endStream()

virtual void Async::AudioContainerOpus::endStream ( void )

virtual

Indicate to the container that the stream has ended.

This function should be called when the stream has ended. The container can then flush the last samples in any buffers and maybe write an end record if applicable. All this will happen through the writeBlock signal.

Reimplemented from Async::AudioContainer.

filenameExtension()

virtual const char * Async::AudioContainerOpus::filenameExtension ( void ) const

inlinevirtual

Get the standard filename extension for the audio container.

Returns

Returns a string containing the filename extention, e.g. wav

Implements Async::AudioContainer.

Definition at line 151 of file AsyncAudioContainerOpus.h.

header()

virtual const char * Async::AudioContainerOpus::header ( void )

inlinevirtual

Get the header data.

Returns

Return a pointer to the header data

This function is normally called as the last thing before closing a file in order to write the header to the beginning of the file. This of course requires that space have been reserved as described in the documentation for the headerSize function.

Reimplemented from Async::AudioContainer.

Definition at line 182 of file AsyncAudioContainerOpus.h.

headerSize()

virtual size_t Async::AudioContainerOpus::headerSize ( void ) const

inlinevirtual

Get the size of the header for this container.

Returns

Returns the size of the header

This function is normally called directly after opening a file to reserve space for writing the header later, usually as the last thing before closing the file.

Reimplemented from Async::AudioContainer.

Definition at line 171 of file AsyncAudioContainerOpus.h.

mediaType()

virtual const char * Async::AudioContainerOpus::mediaType ( void ) const

inlinevirtual

Retrieve the media type for the audio container.

Returns

Returns a string representing the media type, e.g. audio/wav

Implements Async::AudioContainer.

Definition at line 145 of file AsyncAudioContainerOpus.h.

Member Data Documentation

OBJNAME

const char* Async::AudioContainerOpus::OBJNAME = "opus"

staticconstexpr

The name of this class when used by the object factory.

Definition at line 129 of file AsyncAudioContainerOpus.h.

---

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

• AsyncAudioContainerOpus.h