liboggplay  0.3.0
Functions
oggplay_query.h File Reference

oggplay_query.h More...

#include <oggz/oggz.h>

Go to the source code of this file.

Functions

int oggplay_get_num_tracks (OggPlay *me)
 Get the number of tracks in the Ogg container. More...
 
OggzStreamContent oggplay_get_track_type (OggPlay *me, int track_num)
 Retrieve the type of a track. More...
 
const char * oggplay_get_track_typename (OggPlay *me, int track_num)
 Get a track's type name. More...
 
OggPlayErrorCode oggplay_set_track_active (OggPlay *me, int track_num)
 Set a track active. More...
 
OggPlayErrorCode oggplay_set_track_inactive (OggPlay *me, int track_num)
 Inactivate a given track. More...
 

Detailed Description

oggplay_query.h

Authors
Shane Stephens shane.nosp@m..ste.nosp@m.phens.nosp@m.@ann.nosp@m.odex..nosp@m.net Viktor Gal

Function Documentation

int oggplay_get_num_tracks ( OggPlay me)

Get the number of tracks in the Ogg container.

Parameters
meOggPlay handle
Return values
> 0number of tracks
E_OGGPLAY_BAD_OGGPLAYthe supplied OggPlay
E_OGGPLAY_BAD_READER
E_OGGPLAY_UNINITIALISEDthe is not initialised.
OggzStreamContent oggplay_get_track_type ( OggPlay me,
int  track_num 
)

Retrieve the type of a track.

Parameters
meOggPlay handle
track_numthe desired track's number
Return values
> 0the track's type (see OggzStreamContent)
< 0error occured
const char* oggplay_get_track_typename ( OggPlay me,
int  track_num 
)

Get a track's type name.

Parameters
meOggPlay handle
track_numthe desired track's number
Return values
typaname of the track
NULLin case of error.
OggPlayErrorCode oggplay_set_track_active ( OggPlay me,
int  track_num 
)

Set a track active.

Parameters
meOggPlay handle
track_numthe desired track's number for activation
Return values
E_OGGPLAY_OKon success
E_OGGPLAY_BAD_OGGPLAYthe supplied OggPlay is invalid
E_OGGPLAY_BAD_READERthe OggPlayReader associated with the Ogg container is invalid
E_OGGPLAY_UNINITIALISEDthe tracks are not initialised
E_OGGPLAY_BAD_TRACKinvalid track number
E_OGGPLAY_TRACK_IS_SKELETONthe chosen track is a Skeleton track
E_OGGPLAY_TRACK_IS_UNKNOWNthe chosen track's content type is unknown
E_OGGPLAY_TRACK_UNINITIALISEDthe chosen track was not initialised
E_OGGPLAY_TRACK_IS_OVERthe track is over.
OggPlayErrorCode oggplay_set_track_inactive ( OggPlay me,
int  track_num 
)

Inactivate a given track.

Parameters
meOggPlay handle
track_numthe desired track's number for inactivation
Return values
E_OGGPLAY_OKon success
E_OGGPLAY_BAD_OGGPLAYthe supplied OggPlay is invalid
E_OGGPLAY_BAD_READERthe OggPlayReader associated with the Ogg container is invalid
E_OGGPLAY_UNINITIALISEDthe tracks are not initialised
E_OGGPLAY_BAD_TRACKinvalid track number
E_OGGPLAY_TRACK_IS_SKELETONthe chosen track is a Skeleton track
E_OGGPLAY_TRACK_IS_UNKNOWNthe chosen track's content type is unknown