Miam-Player  0.8.0
A nice music player
QtAV::AudioEncoder Class Referenceabstract

#include <AudioEncoder.h>

Inheritance diagram for QtAV::AudioEncoder:
QtAV::AVEncoder

Signals

void audioFormatChanged ()
 
- Signals inherited from QtAV::AVEncoder
void error (const QtAV::AVError &e)
 
void codecNameChanged ()
 
void bitRateChanged ()
 
void timestampModeChanged (TimestampMode mode)
 

Public Member Functions

virtual AudioEncoderId id () const =0
 
QString name () const Q_DECL_OVERRIDE
 
virtual bool encode (const AudioFrame &frame=AudioFrame())=0
 encode encode a audio frame to a Packet More...
 
const AudioFormataudioFormat () const
 output parameters More...
 
void setAudioFormat (const AudioFormat &format)
 
- Public Member Functions inherited from QtAV::AVEncoder
virtual ~AVEncoder ()
 
virtual QString description () const
 
void setCodecName (const QString &name)
 setCodecName An encoder can support more than 1 codec. More...
 
QString codecName () const
 
bool open ()
 
bool close ()
 
bool isOpen () const
 
virtual void flush ()
 
Packet encoded () const
 
virtual void copyAVCodecContext (void *ctx)
 used by ff muxer. More...
 
void * codecContext () const
 
void setBitRate (int value)
 setBitRate Higher bit rate result in better quality. More...
 
int bitRate () const
 
TimestampMode timestampMode () const
 
void setTimestampMode (TimestampMode value)
 
void setOptions (const QVariantHash &dict)
 setOptions More...
 
QVariantHash options () const
 

Static Public Member Functions

static QStringList supportedCodecs ()
 
static AudioEncodercreate (AudioEncoderId id)
 
static AudioEncodercreate (const char *name="FFmpeg")
 create create an encoder from registered names More...
 
template<class C >
static bool Register (AudioEncoderId id, const char *name)
 
static AudioEncoderIdnext (AudioEncoderId *id=0)
 next More...
 
static const char * name (AudioEncoderId id)
 
static AudioEncoderId id (const char *name)
 

Protected Member Functions

 AudioEncoder (AudioEncoderPrivate &d)
 
- Protected Member Functions inherited from QtAV::AVEncoder
 AVEncoder (AVEncoderPrivate &d)
 

Properties

QtAV::AudioFormat audioFormat
 
- Properties inherited from QtAV::AVEncoder
int bitRate
 
QString codecName
 
TimestampMode timestampMode
 

Additional Inherited Members

- Public Types inherited from QtAV::AVEncoder
enum  TimestampMode { TimestampMonotonic, TimestampCopy }
 

Constructor & Destructor Documentation

◆ AudioEncoder()

QtAV::AudioEncoder::AudioEncoder ( AudioEncoderPrivate d)
protected

Member Function Documentation

◆ audioFormat()

const AudioFormat& QtAV::AudioEncoder::audioFormat ( ) const

output parameters

audioFormat If not set or set to an invalid format, a supported format will be used and audioFormat() will be that format after open()

Returns
TODO: check supported formats

◆ audioFormatChanged

void QtAV::AudioEncoder::audioFormatChanged ( )
signal

◆ create() [1/2]

static AudioEncoder* QtAV::AudioEncoder::create ( AudioEncoderId  id)
static

◆ create() [2/2]

static AudioEncoder* QtAV::AudioEncoder::create ( const char *  name = "FFmpeg")
static

create create an encoder from registered names

Parameters
namecan be "FFmpeg". FFmpeg encoder will be created for empty name
Returns
0 if not registered

◆ encode()

virtual bool QtAV::AudioEncoder::encode ( const AudioFrame frame = AudioFrame())
pure virtual

encode encode a audio frame to a Packet

Parameters
framepass an invalid frame to get delayed frames
Returns

◆ id() [1/2]

virtual AudioEncoderId QtAV::AudioEncoder::id ( ) const
pure virtual

◆ id() [2/2]

static AudioEncoderId QtAV::AudioEncoder::id ( const char *  name)
static

◆ name() [1/2]

QString QtAV::AudioEncoder::name ( ) const
virtual

Implements QtAV::AVEncoder.

◆ name() [2/2]

static const char* QtAV::AudioEncoder::name ( AudioEncoderId  id)
static

◆ next()

static AudioEncoderId* QtAV::AudioEncoder::next ( AudioEncoderId id = 0)
static

next

Parameters
idNULL to get the first id address
Returns
address of id or NULL if not found/end

◆ Register()

template<class C >
static bool QtAV::AudioEncoder::Register ( AudioEncoderId  id,
const char *  name 
)
inlinestatic

◆ setAudioFormat()

void QtAV::AudioEncoder::setAudioFormat ( const AudioFormat format)

◆ supportedCodecs()

static QStringList QtAV::AudioEncoder::supportedCodecs ( )
static

Property Documentation

◆ audioFormat

QtAV::AudioFormat QtAV::AudioEncoder::audioFormat
readwrite

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