![]() |
![]() |
![]() |
OGMRip Reference Manual | ![]() |
---|---|---|---|---|
#include <ogmrip-container.h> void (*OGMRipContainerCodecFunc) (OGMRipContainer *container, OGMRipCodec *codec, guint demuxer, gint language, gpointer user_data); void (*OGMRipContainerFileFunc) (OGMRipContainer *container, OGMRipFile *file, gpointer user_data); OGMRipContainer; gchar* ogmrip_container_get_output (OGMRipContainer *container); void ogmrip_container_set_output (OGMRipContainer *container, const gchar *output); gchar* ogmrip_container_get_label (OGMRipContainer *container); void ogmrip_container_set_label (OGMRipContainer *container, const gchar *label); gchar* ogmrip_container_get_fourcc (OGMRipContainer *container); void ogmrip_container_set_fourcc (OGMRipContainer *container, const gchar *fourcc); OGMRipVideo* ogmrip_container_get_video (OGMRipContainer *container); void ogmrip_container_set_video (OGMRipContainer *container, OGMRipVideo *video); void ogmrip_container_add_audio (OGMRipContainer *container, OGMRipAudio *audio, OGMRipAudioDemuxer demuxer, gint language); GSList* ogmrip_container_get_audio (OGMRipContainer *container); OGMRipAudio* ogmrip_container_get_nth_audio (OGMRipContainer *container, gint n); gint ogmrip_container_get_n_audio (OGMRipContainer *container); void ogmrip_container_foreach_audio (OGMRipContainer *container, OGMRipContainerCodecFunc func, gpointer data); void ogmrip_container_add_subp (OGMRipContainer *container, OGMRipSubp *subp, OGMRipSubpDemuxer demuxer, gint language); GSList* ogmrip_container_get_subp (OGMRipContainer *container); gint ogmrip_container_get_n_subp (OGMRipContainer *container); OGMRipSubp* ogmrip_container_get_nth_subp (OGMRipContainer *container, gint n); void ogmrip_container_foreach_subp (OGMRipContainer *container, OGMRipContainerCodecFunc func, gpointer data); void ogmrip_container_add_chapters (OGMRipContainer *container, OGMRipChapters *chapters, gint language); GSList* ogmrip_container_get_chapters (OGMRipContainer *container); OGMRipChapters* ogmrip_container_get_nth_chapters (OGMRipContainer *container, gint n); gint ogmrip_container_get_n_chapters (OGMRipContainer *container); void ogmrip_container_foreach_chapters (OGMRipContainer *container, OGMRipContainerCodecFunc func, gpointer data); void ogmrip_container_add_file (OGMRipContainer *container, OGMRipFile *file); GSList* ogmrip_container_get_files (OGMRipContainer *container); OGMRipFile* ogmrip_container_get_nth_file (OGMRipContainer *container, gint n); gint ogmrip_container_get_n_files (OGMRipContainer *container); void ogmrip_container_foreach_file (OGMRipContainer *container, OGMRipContainerFileFunc func, gpointer data); void ogmrip_container_set_split (OGMRipContainer *container, guint number, guint size); void ogmrip_container_get_split (OGMRipContainer *container, guint *number, guint *size); gint64 ogmrip_container_get_overhead_size (OGMRipContainer *container); gint64 ogmrip_container_get_nonvideo_size (OGMRipContainer *container);
"fourcc" gchararray : Read / Write "label" gchararray : Read / Write "output" gchararray : Read / Write "overhead" guint : Read "start-delay" guint : Read / Write "target-number" guint : Read / Write "target-size" guint : Read / Write
void (*OGMRipContainerCodecFunc) (OGMRipContainer *container, OGMRipCodec *codec, guint demuxer, gint language, gpointer user_data);
Specifies the type of functions passed to ogmrip_container_foreach_audio()
,
ogmrip_container_foreach_subp()
, and ogmrip_container_foreach_chapters()
.
container : |
An OGMRipContainer |
codec : |
An OGMRipCodec |
demuxer : |
The demuxer to be used |
language : |
The language of the stream |
user_data : |
The user data |
void (*OGMRipContainerFileFunc) (OGMRipContainer *container, OGMRipFile *file, gpointer user_data);
Specifies the type of functions passed to ogmrip_container_foreach_file()
.
container : |
An OGMRipContainer |
file : |
An OGMRipFile |
user_data : |
The user data |
gchar* ogmrip_container_get_output (OGMRipContainer *container);
Gets the name of the output file.
container : |
An OGMRipContainer |
Returns : | The filename, or NULL |
void ogmrip_container_set_output (OGMRipContainer *container, const gchar *output);
Sets the name of the output file.
container : |
an OGMRipContainer |
output : |
the name of the output file |
gchar* ogmrip_container_get_label (OGMRipContainer *container);
Gets the label of the rip.
container : |
An OGMRipContainer |
Returns : | The label, or NULL |
void ogmrip_container_set_label (OGMRipContainer *container, const gchar *label);
Sets the label of the rip.
container : |
An OGMRipContainer |
label : |
the label |
gchar* ogmrip_container_get_fourcc (OGMRipContainer *container);
Gets the FourCC of the rip.
container : |
An OGMRipContainer |
Returns : | The FourCC, or NULL |
void ogmrip_container_set_fourcc (OGMRipContainer *container, const gchar *fourcc);
Sets the FourCC of the rip.
container : |
An OGMRipContainer |
fourcc : |
the FourCC |
OGMRipVideo* ogmrip_container_get_video (OGMRipContainer *container);
Gets the video codec of the rip.
container : |
An OGMRipContainer |
Returns : | An OGMRipVideo, or NULL |
void ogmrip_container_set_video (OGMRipContainer *container, OGMRipVideo *video);
Sets the video codec of the rip.
container : |
An OGMRipContainer |
video : |
An OGMRipVideo |
void ogmrip_container_add_audio (OGMRipContainer *container, OGMRipAudio *audio, OGMRipAudioDemuxer demuxer, gint language);
Adds an audio codec to the rip.
container : |
An OGMRipContainer |
audio : |
An OGMRipAudio |
demuxer : |
The demuxer to be used |
language : |
The language of the stream |
GSList* ogmrip_container_get_audio (OGMRipContainer *container);
Gets a list of the audio codecs of the rip.
container : |
An OGMRipContainer |
Returns : | A GSList, or NULL |
OGMRipAudio* ogmrip_container_get_nth_audio (OGMRipContainer *container, gint n);
Gets the audio codec at the given position.
container : |
an OGMRipContainer |
n : |
The index of the audio codec |
Returns : | An OGMRipAudio, or NULL |
gint ogmrip_container_get_n_audio (OGMRipContainer *container);
Gets the number of audio codecs.
container : |
an OGMRipContainer |
Returns : | the number of audio codecs |
void ogmrip_container_foreach_audio (OGMRipContainer *container, OGMRipContainerCodecFunc func, gpointer data);
Calls a function for each audio codec
container : |
an OGMRipContainer |
func : |
The function to call with each audio codec |
data : |
User data to pass to the function |
void ogmrip_container_add_subp (OGMRipContainer *container, OGMRipSubp *subp, OGMRipSubpDemuxer demuxer, gint language);
Adds a subtitle codec to the rip.
container : |
An OGMRipContainer |
subp : |
An OGMRipSubp |
demuxer : |
The demuxer to be used |
language : |
The language of the stream |
GSList* ogmrip_container_get_subp (OGMRipContainer *container);
Gets a list of the subtitle codecs of the rip.
container : |
An OGMRipContainer |
Returns : | A GSList, or NULL |
gint ogmrip_container_get_n_subp (OGMRipContainer *container);
Gets the number of subtitle codecs.
container : |
an OGMRipContainer |
Returns : | the number of subtitle codecs |
OGMRipSubp* ogmrip_container_get_nth_subp (OGMRipContainer *container, gint n);
Gets the subtitle codec at the given position.
container : |
an OGMRipContainer |
n : |
The index of the subtitle codec |
Returns : | An OGMRipSubp, or NULL |
void ogmrip_container_foreach_subp (OGMRipContainer *container, OGMRipContainerCodecFunc func, gpointer data);
Calls a function for each subtitle codec
container : |
An OGMRipContainer |
func : |
The function to call with each subtitle codec |
data : |
User data to pass to the function |
void ogmrip_container_add_chapters (OGMRipContainer *container, OGMRipChapters *chapters, gint language);
Adds a chapters codec to the rip.
container : |
An OGMRipContainer |
chapters : |
An OGMRipChapters |
language : |
The language of the chapters |
GSList* ogmrip_container_get_chapters (OGMRipContainer *container);
Gets a list of the chapters codecs of the rip.
container : |
An OGMRipContainer |
Returns : | A GSList, or NULL |
OGMRipChapters* ogmrip_container_get_nth_chapters (OGMRipContainer *container, gint n);
Gets the chapters codec at the given position.
container : |
an OGMRipContainer |
n : |
The index of the chapters codec |
Returns : | An OGMRipChapters, or NULL |
gint ogmrip_container_get_n_chapters (OGMRipContainer *container);
Gets the number of chapters codecs.
container : |
an OGMRipContainer |
Returns : | the number of chapters codecs |
void ogmrip_container_foreach_chapters (OGMRipContainer *container, OGMRipContainerCodecFunc func, gpointer data);
Calls a function for each chapters codec
container : |
An OGMRipContainer |
func : |
The function to call with each chapters codec |
data : |
User data to pass to the function |
void ogmrip_container_add_file (OGMRipContainer *container, OGMRipFile *file);
Adds a file to the rip.
container : |
An OGMRipContainer |
file : |
An OOGMRipFile |
GSList* ogmrip_container_get_files (OGMRipContainer *container);
Gets a list of the files of the rip.
container : |
An OGMRipContainer |
Returns : | A GSList, or NULL |
OGMRipFile* ogmrip_container_get_nth_file (OGMRipContainer *container, gint n);
Gets the file at the given position.
container : |
an OGMRipContainer |
n : |
The index of the file |
Returns : | An OGMRipFile, or NULL |
gint ogmrip_container_get_n_files (OGMRipContainer *container);
Gets the number of files.
container : |
an OGMRipContainer |
Returns : | the number of files |
void ogmrip_container_foreach_file (OGMRipContainer *container, OGMRipContainerFileFunc func, gpointer data);
Calls a function for each file
container : |
An OGMRipContainer |
func : |
The function to call with each file |
data : |
User data to pass to the function |
void ogmrip_container_set_split (OGMRipContainer *container, guint number, guint size);
Sets the number of output files and the maximum size of each one.
container : |
An OGMRipContainer |
number : |
The number of file |
size : |
The size of each file |
void ogmrip_container_get_split (OGMRipContainer *container, guint *number, guint *size);
Gets the number of output files and the maximum size of each one.
container : |
An OGMRipContainer |
number : |
A pointer to store the number of file |
size : |
A pointer to store the size of each file |
gint64 ogmrip_container_get_overhead_size (OGMRipContainer *container);
Returns the size of the overhead generated by the video, audio and subtitle stream, the chapters information and the files in bytes.
container : |
An OGMRipContainer |
Returns : | The overhead size |
gint64 ogmrip_container_get_nonvideo_size (OGMRipContainer *container);
Returns the size of the audio and subtitle streams, the chapters information and the files in bytes.
container : |
An OGMRipContainer |
Returns : | The nonvideo size |