liboggplay  0.3.0
Typedefs | Enumerations
oggplay_enums.h File Reference

General constants used by liboggplay. More...

Go to the source code of this file.

Typedefs

typedef enum OggPlayErrorCode OggPlayErrorCode
 Definitions of error return values.
 
typedef enum OggPlayDataType OggPlayDataType
 Definitions of the various record types.
 
typedef enum OggPlayStreamInfo OggPlayStreamInfo
 Definitions of the various states of a stream.
 

Enumerations

enum  OggPlayErrorCode {
  E_OGGPLAY_CONTINUE = 1, E_OGGPLAY_OK = 0, E_OGGPLAY_BAD_OGGPLAY = -1, E_OGGPLAY_BAD_READER = -2,
  E_OGGPLAY_BAD_INPUT = -3, E_OGGPLAY_NO_SUCH_CHUNK = -4, E_OGGPLAY_BAD_TRACK = -5, E_OGGPLAY_TRACK_IS_SKELETON = -6,
  E_OGGPLAY_OGGZ_UNHAPPY = -7, E_OGGPLAY_END_OF_FILE = -8, E_OGGPLAY_TRACK_IS_OVER = -9, E_OGGPLAY_BAD_CALLBACK_INFO = -10,
  E_OGGPLAY_WRONG_TRACK_TYPE = -11, E_OGGPLAY_UNINITIALISED = -12, E_OGGPLAY_CALLBACK_MODE = -13, E_OGGPLAY_BUFFER_MODE = -14,
  E_OGGPLAY_USER_INTERRUPT = -15, E_OGGPLAY_SOCKET_ERROR = -16, E_OGGPLAY_TIMEOUT = -17, E_OGGPLAY_CANT_SEEK = -18,
  E_OGGPLAY_NO_KATE_SUPPORT = -19, E_OGGPLAY_NO_TIGER_SUPPORT = -20, E_OGGPLAY_OUT_OF_MEMORY = -21, E_OGGPLAY_TYPE_OVERFLOW = -22,
  E_OGGPLAY_TRACK_IS_UNKNOWN = -23, E_OGGPLAY_TRACK_UNINITIALISED = -24, E_OGGPLAY_NOTCHICKENPAYBACK = -777
}
 Definitions of error return values. More...
 
enum  OggPlayDataType {
  OGGPLAY_INACTIVE = -1, OGGPLAY_YUV_VIDEO = 0, OGGPLAY_RGBA_VIDEO = 1, OGGPLAY_SHORTS_AUDIO = 1000,
  OGGPLAY_FLOATS_AUDIO = 1001, OGGPLAY_CMML = 2000, OGGPLAY_KATE = 3000, OGGPLAY_TYPE_UNKNOWN = 9000
}
 Definitions of the various record types. More...
 
enum  OggPlayStreamInfo {
  OGGPLAY_STREAM_UNINITIALISED = 0, OGGPLAY_STREAM_FIRST_DATA = 1, OGGPLAY_STREAM_INITIALISED = 2, OGGPLAY_STREAM_LAST_DATA = 3,
  OGGPLAY_STREAM_JUST_SEEKED = 4
}
 Definitions of the various states of a stream. More...
 

Detailed Description

General constants used by liboggplay.

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

Enumeration Type Documentation

Definitions of the various record types.

Enumerator
OGGPLAY_INACTIVE 

record is inactive

OGGPLAY_YUV_VIDEO 

record is a YUV format video

OGGPLAY_RGBA_VIDEO 

record is a video in RGB format

OGGPLAY_SHORTS_AUDIO 

audio record in short format

OGGPLAY_FLOATS_AUDIO 

audio record in float format

OGGPLAY_CMML 

CMML record.

OGGPLAY_KATE 

KATE record.

OGGPLAY_TYPE_UNKNOWN 

content type of the record is unknown

Definitions of error return values.

Enumerator
E_OGGPLAY_OK 

No error.

E_OGGPLAY_BAD_OGGPLAY 

supplied oggplay is not a valid OggPlay

E_OGGPLAY_BAD_READER 

OggPlayReader is invalid.

E_OGGPLAY_BAD_INPUT 

Error in the input.

E_OGGPLAY_BAD_TRACK 

The requested track number does not exists.

E_OGGPLAY_TRACK_IS_SKELETON 

Trying to activate a Skeleton track.

E_OGGPLAY_OGGZ_UNHAPPY 

OGGZ error occured.

E_OGGPLAY_END_OF_FILE 

End of file.

E_OGGPLAY_TRACK_IS_OVER 

A given track has ended.

E_OGGPLAY_BAD_CALLBACK_INFO 

Invalid OggPlayCallbackInfo.

E_OGGPLAY_UNINITIALISED 

The OggPlay handle is not initialised.

E_OGGPLAY_CALLBACK_MODE 

OggPlay is used in callback mode.

E_OGGPLAY_BUFFER_MODE 

OggPlay is used in buffer mode.

E_OGGPLAY_USER_INTERRUPT 

User interrupt received.

E_OGGPLAY_SOCKET_ERROR 

Error while creating socket.

E_OGGPLAY_TIMEOUT 

TCP connection timeouted.

E_OGGPLAY_CANT_SEEK 

Could not performed the requested seek.

E_OGGPLAY_NO_KATE_SUPPORT 

LibKate is not supported.

E_OGGPLAY_NO_TIGER_SUPPORT 

LibTiger is not supported.

E_OGGPLAY_OUT_OF_MEMORY 

Out of memory.

E_OGGPLAY_TYPE_OVERFLOW 

Integer overflow detected.

E_OGGPLAY_TRACK_IS_UNKNOWN 

The selected track's content type is UNKNOWN.

E_OGGPLAY_TRACK_UNINITIALISED 

Track is not initialised, i.e.

bad headers or haven't seen them

Definitions of the various states of a stream.

Enumerator
OGGPLAY_STREAM_UNINITIALISED 

Stream is not initialised.

OGGPLAY_STREAM_FIRST_DATA 

Stream received it's first data frame.

OGGPLAY_STREAM_INITIALISED 

Stream is initialised.

OGGPLAY_STREAM_LAST_DATA 

Stream received it's last data frame.

OGGPLAY_STREAM_JUST_SEEKED 

We've just seeked in the stream.