oggplay_callback_info.h File Reference

oggplay_callback_info.h More...

Go to the source code of this file.

Data Structures

struct  OggPlayVideoData
 structure for storing a YUV video frame More...
struct  OggPlayOverlayData
 structure for storing a video frame in RGB fromat More...

Typedefs

typedef void * OggPlayAudioData
 Type for representing audio data.
typedef char OggPlayTextData
 Type for representing text data.
typedef struct _OggPlayDataHeader OggPlayDataHeader
 Header for the various data formats.

Functions

OggPlayDataType oggplay_callback_info_get_type (OggPlayCallbackInfo *info)
 Get the data type of the given OggPlayCallbackInfo.
int oggplay_callback_info_get_available (OggPlayCallbackInfo *info)
int oggplay_callback_info_get_required (OggPlayCallbackInfo *info)
OggPlayDataHeader ** oggplay_callback_info_get_headers (OggPlayCallbackInfo *info)
 Get the array of records stored in the OggPlayCallbackInfo.
ogg_int64_t oggplay_callback_info_get_record_size (OggPlayDataHeader *header)
 Get the size of the given record.
OggPlayVideoDataoggplay_callback_info_get_video_data (OggPlayDataHeader *header)
 Extract the video frame from the supplied record.
OggPlayOverlayDataoggplay_callback_info_get_overlay_data (OggPlayDataHeader *header)
 Extract the overlay data from the supplied record.
OggPlayAudioDataoggplay_callback_info_get_audio_data (OggPlayDataHeader *header)
 Extract the audio data from the supplied record.
OggPlayTextDataoggplay_callback_info_get_text_data (OggPlayDataHeader *header)
 Extract the text data from the supplied record.
OggPlayStreamInfo oggplay_callback_info_get_stream_info (OggPlayCallbackInfo *info)
 Get the state of the stream.
void oggplay_callback_info_lock_item (OggPlayDataHeader *header)
void oggplay_callback_info_unlock_item (OggPlayDataHeader *header)
long oggplay_callback_info_get_presentation_time (OggPlayDataHeader *header)
 Get the presentation time of the given record.

Detailed Description

oggplay_callback_info.h

Authors:
Shane Stephens <shane.stephens@annodex.net> Michael Martin Viktor Gal

Function Documentation

OggPlayAudioData* oggplay_callback_info_get_audio_data ( OggPlayDataHeader header  ) 

Extract the audio data from the supplied record.

Parameters:
header 
Returns:
OggPlayAudioData.
Return values:
NULL if the supplied OggPlayCallbackInfo is a NULL pointer
OggPlayDataHeader** oggplay_callback_info_get_headers ( OggPlayCallbackInfo info  ) 

Get the array of records stored in the OggPlayCallbackInfo.

Parameters:
info 
Returns:
array of records
Return values:
NULL if the supplied OggPlayCallbackInfo is a NULL pointer
OggPlayOverlayData* oggplay_callback_info_get_overlay_data ( OggPlayDataHeader header  ) 

Extract the overlay data from the supplied record.

Parameters:
header 
Returns:
OggPlayOverlayData
Return values:
NULL if the supplied OggPlayCallbackInfo is a NULL pointer
long oggplay_callback_info_get_presentation_time ( OggPlayDataHeader header  ) 

Get the presentation time of the given record.

Parameters:
header 
Returns:
presentation time of the given frame in milliseconds.
ogg_int64_t oggplay_callback_info_get_record_size ( OggPlayDataHeader header  ) 

Get the size of the given record.

Parameters:
header 
Returns:
The number of samples in the record.
OggPlayStreamInfo oggplay_callback_info_get_stream_info ( OggPlayCallbackInfo info  ) 

Get the state of the stream.

Parameters:
info 
Returns:
State of the given stream.
See also:
OggPlayStreamInfo
OggPlayTextData* oggplay_callback_info_get_text_data ( OggPlayDataHeader header  ) 

Extract the text data from the supplied record.

Parameters:
header 
Returns:
OggPlayTextData
Return values:
NULL if the supplied OggPlayCallbackInfo is a NULL pointer
OggPlayDataType oggplay_callback_info_get_type ( OggPlayCallbackInfo info  ) 

Get the data type of the given OggPlayCallbackInfo.

Parameters:
info 
Returns:
The data type of the given OggPlayCallbackInfo
See also:
OggPlayDataType
OggPlayVideoData* oggplay_callback_info_get_video_data ( OggPlayDataHeader header  ) 

Extract the video frame from the supplied record.

Parameters:
header 
Returns:
the video frame
Return values:
NULL if the supplied OggPlayCallbackInfo is a NULL pointer

Generated on Sat Dec 26 23:56:53 2009 for liboggplay by  doxygen 1.6.1