oggplay_query.h File Reference
oggplay_query.h  
More...
#include <oggz/oggz.h>
Go to the source code of this file.
Detailed Description
oggplay_query.h 
- Authors:
- Shane Stephens <shane.stephens@annodex.net> Viktor Gal 
Function Documentation
      
        
          | int oggplay_get_num_tracks | ( | OggPlay * | me | ) |  | 
      
 
Get the number of tracks in the Ogg container. 
- Parameters:
- 
  
  
- Return values:
- 
  
    |  | > 0 | number of tracks |  |  | E_OGGPLAY_BAD_OGGPLAY | the supplied OggPlay |  |  | E_OGGPLAY_BAD_READER |  |  |  | E_OGGPLAY_UNINITIALISED | the is not initialised. |  
 
 
 
      
        
          | OggzStreamContent oggplay_get_track_type | ( | OggPlay * | me, | 
        
          |  |  | int | track_num |  | 
        
          |  | ) |  |  |  | 
      
 
Retrieve the type of a track. 
- Parameters:
- 
  
    |  | me | OggPlay handle |  |  | track_num | the desired track's number |  
 
- Return values:
- 
  
    |  | > 0 | the track's type (see OggzStreamContent) |  |  | < 0 | error occured |  
 
 
 
      
        
          | const char* oggplay_get_track_typename | ( | OggPlay * | me, | 
        
          |  |  | int | track_num |  | 
        
          |  | ) |  |  |  | 
      
 
Get a track's type name. 
- Parameters:
- 
  
    |  | me | OggPlay handle |  |  | track_num | the desired track's number |  
 
- Return values:
- 
  
    |  | typa | name of the track |  |  | NULL | in case of error. |  
 
 
 
Set a track active. 
- Parameters:
- 
  
    |  | me | OggPlay handle |  |  | track_num | the desired track's number for activation |  
 
- Return values:
- 
  
    |  | E_OGGPLAY_OK | on success |  |  | E_OGGPLAY_BAD_OGGPLAY | the supplied OggPlay is invalid |  |  | E_OGGPLAY_BAD_READER | the OggPlayReader associated with the Ogg container is invalid |  |  | E_OGGPLAY_UNINITIALISED | the tracks are not initialised |  |  | E_OGGPLAY_BAD_TRACK | invalid track number |  |  | E_OGGPLAY_TRACK_IS_SKELETON | the chosen track is a Skeleton track |  |  | E_OGGPLAY_TRACK_IS_UNKNOWN | the chosen track's content type is unknown |  |  | E_OGGPLAY_TRACK_UNINITIALISED | the chosen track was not initialised |  |  | E_OGGPLAY_TRACK_IS_OVER | the track is over. |  
 
 
 
Inactivate a given track. 
- Parameters:
- 
  
    |  | me | OggPlay handle |  |  | track_num | the desired track's number for inactivation |  
 
- Return values:
- 
  
    |  | E_OGGPLAY_OK | on success |  |  | E_OGGPLAY_BAD_OGGPLAY | the supplied OggPlay is invalid |  |  | E_OGGPLAY_BAD_READER | the OggPlayReader associated with the Ogg container is invalid |  |  | E_OGGPLAY_UNINITIALISED | the tracks are not initialised |  |  | E_OGGPLAY_BAD_TRACK | invalid track number |  |  | E_OGGPLAY_TRACK_IS_SKELETON | the chosen track is a Skeleton track |  |  | E_OGGPLAY_TRACK_IS_UNKNOWN | the chosen track's content type is unknown |