VlcAudio Class Reference

Audio controls. More...

#include <vlc-qt/Audio.h>

Public Member Functions

 VlcAudio (VlcMediaPlayer *player)
 VlcAudio constructor. More...
 
 ~VlcAudio ()
 VlcAudio destructor.
 
bool getMute () const
 Get current mute status. More...
 
void setVolume (int volume)
 Set current audio level. More...
 
void setTrack (int track)
 Set current audio track. More...
 
bool toggleMute () const
 Toggle mute status. 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...
 
int volume () const
 Get current audio level. More...
 

Detailed Description

A group of audio controls functions.

Constructor & Destructor Documentation

VlcAudio::VlcAudio ( VlcMediaPlayer player)
explicit

This constructor creates a new audio manager.

Parameters
playermedia player (VlcMediaPlayer *)

Member Function Documentation

bool VlcAudio::getMute ( ) const
Returns
current mute status (const bool)
void VlcAudio::setTrack ( int  track)
Parameters
tracknew audio track (int)
void VlcAudio::setVolume ( int  volume)
Parameters
volumenew audio level (int)
bool VlcAudio::toggleMute ( ) const
Returns
new mute status (const bool)
int VlcAudio::track ( ) const
Returns
the number of current audio track, or -1 if none (const int)
int VlcAudio::trackCount ( ) const
Returns
the number of available audio tracks, or -1 if unavailable (const int)
QStringList VlcAudio::trackDescription ( ) const
Returns
list with description of available audio tracks (const QStringList)
QList< int > VlcAudio::trackIds ( ) const
Returns
list with ids of available audio tracks (const QList<int>)
int VlcAudio::volume ( ) const
Returns
current audio level, -1 if media is not playing (const int)

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