VlcAudio Class Reference

Audio controls. More...

#include <VLCQtCore/Audio.h>

Public Slots

void setVolume (int volume)
 Set current audio level. More...
 
void setTrack (int track)
 Set current audio track. More...
 
bool toggleMute () const
 Toggle mute state. More...
 
void setChannel (Vlc::AudioChannel channel)
 Set audio channel. More...
 
void setMute (bool mute) const
 Set mute state. More...
 

Signals

void volumeChangedF (float volume)
 Signal sent when volume has changed. More...
 
void volumeChanged (int volume)
 Signal sent when volume has changed. More...
 
void muteChanged (bool mute)
 Signal sent when mute has changed. More...
 

Public Member Functions

 VlcAudio (VlcMediaPlayer *player)
 VlcAudio constructor. More...
 
 ~VlcAudio ()
 VlcAudio destructor.
 
bool getMute () const
 Get current mute state. More...
 
int track () const
 Get current audio track. More...
 
int trackCount () const
 Get number of available audio tracks. More...
 
QStringList trackDescription () const
 Get the description of available audio tracks. More...
 
QList< int > trackIds () const
 Get the ids of available audio tracks. More...
 
QMap< int, QString > tracks () const
 Get available audio tracks. More...
 
int volume () const
 Get current audio level. More...
 
Vlc::AudioChannel channel () const
 Get audio channel. More...
 

Friends

class VlcAudioCallbackHelper
 

Detailed Description

Audio controls.

A group of audio controls functions.

Constructor & Destructor Documentation

VlcAudio::VlcAudio ( VlcMediaPlayer player)
explicit

VlcAudio constructor.

This constructor creates a new audio manager.

Parameters
playermedia player (VlcMediaPlayer *)

Member Function Documentation

Vlc::AudioChannel VlcAudio::channel ( ) const

Get audio channel.

Returns
current audio channel, -1 if error
bool VlcAudio::getMute ( ) const

Get current mute state.

Returns
current mute state (const bool)
void VlcAudio::muteChanged ( bool  mute)
signal

Signal sent when mute has changed.

Parameters
mutenew mute state (bool)
void VlcAudio::setChannel ( Vlc::AudioChannel  channel)
slot

Set audio channel.

Parameters
channelnew audio channel
void VlcAudio::setMute ( bool  mute) const
slot

Set mute state.

Parameters
mutemute state (bool)
void VlcAudio::setTrack ( int  track)
slot

Set current audio track.

Parameters
tracknew audio track (int)
void VlcAudio::setVolume ( int  volume)
slot

Set current audio level.

Parameters
volumenew audio level (int)
bool VlcAudio::toggleMute ( ) const
slot

Toggle mute state.

Returns
new mute state (const bool)
int VlcAudio::track ( ) const

Get current audio track.

Returns
the number of current audio track, or -1 if none (const int)
int VlcAudio::trackCount ( ) const

Get number of available audio tracks.

Returns
the number of available audio tracks, or -1 if unavailable (const int)
QStringList VlcAudio::trackDescription ( ) const

Get the description of available audio tracks.

Returns
list with description of available audio tracks (const QStringList)
QList< int > VlcAudio::trackIds ( ) const

Get the ids of available audio tracks.

Returns
list with ids of available audio tracks (const QList<int>)
QMap< int, QString > VlcAudio::tracks ( ) const

Get available audio tracks.

Returns
dictionary with available audio tracks (const QMap<int, QString>)
Since
VLC-Qt 1.1
int VlcAudio::volume ( ) const

Get current audio level.

Returns
current audio level, -1 if media is not playing (const int)
void VlcAudio::volumeChanged ( int  volume)
signal

Signal sent when volume has changed.

Parameters
volumenew volume (int)
void VlcAudio::volumeChangedF ( float  volume)
signal

Signal sent when volume has changed.

Parameters
volumenew volume (float)

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