Kodi Documentation 18.0
Kodi is an open source media player and entertainment hub.

Functions

virtual bool kodi::addon::CInstanceAudioDecoder::Init (const std::string &filename, unsigned int filecache, int &channels, int &samplerate, int &bitspersample, int64_t &totaltime, int &bitrate, AEDataFormat &format, std::vector< AEChannel > &channellist)=0
 Initialize a decoder. More...
 
virtual int kodi::addon::CInstanceAudioDecoder::ReadPCM (uint8_t *buffer, int size, int &actualsize)=0
 Produce some noise. More...
 
virtual int64_t kodi::addon::CInstanceAudioDecoder::Seek (int64_t time)
 Seek in output stream. More...
 
virtual bool kodi::addon::CInstanceAudioDecoder::ReadTag (const std::string &file, std::string &title, std::string &artist, int &length)
 Read tag of a file. More...
 
virtual int kodi::addon::CInstanceAudioDecoder::TrackCount (const std::string &file)
 Get number of tracks in a file. More...
 

Detailed Description

Function Documentation

◆ Init()

virtual bool kodi::addon::CInstanceAudioDecoder::Init ( const std::string &  filename,
unsigned int  filecache,
int &  channels,
int &  samplerate,
int &  bitspersample,
int64_t &  totaltime,
int &  bitrate,
AEDataFormat format,
std::vector< AEChannel > &  channellist 
)
pure virtual

Initialize a decoder.

Parameters
[in]filenameThe file to read
[in]filecacheThe file cache size
[out]channelsNumber of channels in output stream
[out]samplerateSamplerate of output stream
[out]bitspersampleBits per sample in output stream
[out]totaltimeTotal time for stream
[out]bitrateAverage bitrate of input stream
[out]formatData format for output stream
[out]channellistChannel mapping for output stream
Returns
true if successfully done, otherwise false

◆ ReadPCM()

virtual int kodi::addon::CInstanceAudioDecoder::ReadPCM ( uint8_t buffer,
int  size,
int &  actualsize 
)
pure virtual

Produce some noise.

Parameters
[in]bufferOutput buffer
[in]sizeSize of output buffer
[out]actualsizeActual number of bytes written to output buffer
Returns
Return with following possible values:
Value Description
0 on success
-1 on end of stream
1 on failure

◆ ReadTag()

virtual bool kodi::addon::CInstanceAudioDecoder::ReadTag ( const std::string &  file,
std::string &  title,
std::string &  artist,
int &  length 
)
inlinevirtual

Read tag of a file.

Parameters
[in]fileFile to read tag for
[out]titleTitle of file
[out]artistArtist of file
[out]lengthLength of file
Returns
True on success, false on failure

◆ Seek()

virtual int64_t kodi::addon::CInstanceAudioDecoder::Seek ( int64_t  time)
inlinevirtual

Seek in output stream.

Parameters
[in]timeTime position to seek to in milliseconds
Returns
Time position seek ended up on

◆ TrackCount()

virtual int kodi::addon::CInstanceAudioDecoder::TrackCount ( const std::string &  file)
inlinevirtual

Get number of tracks in a file.

Parameters
[in]fileFile to read tag for
Returns
Number of tracks in file