plugins/videos/api.txt

## Container formats
--------------------

class converter.formats.AviFormat

    Avi container format, often used vith DivX video.

class converter.formats.BaseFormat

    Base format class.

    Supported formats are: ogg, avi, mkv, webm, flv, mov, mp4, mpeg

class converter.formats.FlvFormat

    Flash Video container format.

class converter.formats.MkvFormat

    Matroska format, often used with H.264 video.

class converter.formats.MovFormat

    Mov container format, used mostly with H.264 video content, often for mobile platforms.

class converter.formats.Mp3Format

    Mp3 container, used audio-only mp3 files

class converter.formats.Mp4Format

    Mp4 container format, the default Format for H.264 video content.

class converter.formats.MpegFormat

    MPEG(TS) container, used mainly for MPEG 1/2 video codecs.

class converter.formats.OggFormat

    Ogg container format, mostly used with Vorbis and Theora.

class converter.formats.WebmFormat

    WebM is Google’s variant of Matroska containing only VP8 for video and Vorbis for audio content.


## Audio and video codecs
-------------------------

class converter.avcodecs.AacCodec

    AAC audio codec.

class converter.avcodecs.Ac3Codec

    AC3 audio codec.

class converter.avcodecs.AudioCodec

    Base audio codec class handles general audio options. Possible parameters are:

            codec (string) - audio codec name
            channels (integer) - number of audio channels
            bitrate (integer) - stream bitrate
            samplerate (integer) - sample rate (frequency)

    Supported audio codecs are: null (no audio), copy (copy from original), vorbis, aac, mp3, mp2

class converter.avcodecs.AudioCopyCodec

    Copy audio stream directly from the source.

class converter.avcodecs.AudioNullCodec

    Null audio codec (no audio).

class converter.avcodecs.BaseCodec

    Base audio/video codec class.

class converter.avcodecs.DVBSub

    DVB subtitles.

class converter.avcodecs.DVDSub

    DVD subtitles.

class converter.avcodecs.DivxCodec

    DivX video codec.

class converter.avcodecs.DtsCodec

    DTS audio codec.

class converter.avcodecs.FdkAacCodec

    AAC audio codec.

class converter.avcodecs.FlacCodec

    FLAC audio codec.

class converter.avcodecs.FlvCodec

    Flash Video codec.

class converter.avcodecs.H263Codec

    H.263 video codec.

class converter.avcodecs.H264Codec

    H.264/AVC video codec. @see http://ffmpeg.org/trac/ffmpeg/wiki/x264EncodingGuide

class converter.avcodecs.MOVTextCodec

    mov_text subtitle codec.

class converter.avcodecs.Mp2Codec

    MP2 (MPEG layer 2) audio codec.

class converter.avcodecs.Mp3Codec

    MP3 (MPEG layer 3) audio codec.

class converter.avcodecs.Mpeg1Codec

    MPEG-1 video codec.

class converter.avcodecs.Mpeg2Codec

    MPEG-2 video codec.

class converter.avcodecs.MpegCodec

    Base MPEG video codec.

class converter.avcodecs.SSA

    SSA (SubStation Alpha) subtitle.

class converter.avcodecs.SubRip

    SubRip subtitle.

class converter.avcodecs.SubtitleCodec

    Base subtitle codec class handles general subtitle options. Possible parameters are:

            codec (string) - subtitle codec name (mov_text, subrib, ssa only supported currently)
            language (string) - language of subtitle stream (3 char code)
            forced (int) - force subtitles (1 true, 0 false)
            default (int) - default subtitles (1 true, 0 false)

    Supported subtitle codecs are: null (no subtitle), mov_text

class converter.avcodecs.SubtitleCopyCodec

    Copy subtitle stream directly from the source.

class converter.avcodecs.SubtitleNullCodec

    Null video codec (no video).

class converter.avcodecs.TheoraCodec

    Theora video codec. @see http://ffmpeg.org/trac/ffmpeg/wiki/TheoraVorbisEncodingGuide

class converter.avcodecs.VideoCodec

    Base video codec class handles general video options. Possible parameters are:

            codec (string) - video codec name
            bitrate (string) - stream bitrate
            fps (integer) - frames per second
            width (integer) - video width
            height (integer) - video height

            mode (string) - aspect preserval mode; one of:
                    stretch (default) - don’t preserve aspect
                    crop - crop extra w/h
                    pad - pad with black bars

            src_width (int) - source width
            src_height (int) - source height

    Aspect preserval mode is only used if both source and both destination sizes are specified. If source dimensions are not specified, aspect settings are ignored.

    If source dimensions are specified, and only one of the destination dimensions is specified, the other one is calculated to preserve the aspect ratio.

    Supported video codecs are: null (no video), copy (copy directly from the source), Theora, H.264/AVC, DivX, VP8, H.263, Flv, MPEG-1, MPEG-2.

class converter.avcodecs.VideoCopyCodec

    Copy video stream directly from the source.

class converter.avcodecs.VideoNullCodec

    Null video codec (no video).

class converter.avcodecs.VorbisCodec

    Vorbis audio codec. @see http://ffmpeg.org/trac/ffmpeg/wiki/TheoraVorbisEncodingGuide

class converter.avcodecs.Vp8Codec

    Google VP8 video codec.