Movie

Movie is the main message of the SDL for building DynamicMovies. It consists of Scenes and an Audio object for the whole movie. It also specifies Video and Audio parameters.

Field name Field type Description
Required fields
params StreamParams Audio and Video parameters for this Movie
scenes Scene [ ] An array of Scenes that describes the movie content
Optional fields
audio Audio An Audio object that handles Audio during the whole movie. Additional audio tracks are mixed on top of this Audio track
loop bool Parameter for an endless looping stream (will be ignored for RenderMovie/RenderImagesequence)
audiovarinfo VariableInfo Information about variable values used in audio. Useful for optimization.
initatstart bool Initialise all variables in the movie at startup (sacrificing "time to first byte")

Movie parameters

Codec

Enum Value Description
Video Codecs
VIDEO_NONE 0 No Video
VIDEO_H264 4 Multi-purpose H.264 / MP4 & FLV
VIDEO_X264 6 Main Profile H.264
VIDEO_X264_BASELINE 5 Baseline Profile H.264
VIDEO_X264_HIGH 16 High Profile H.264
VIDEO_VP8 14 Multi-pupose VP8 Video (WebM)
VIDEO_MPEG2 17 MPEG2
VIDEO_WMV 18 Windows Media Video
VIDEO_GIF 19 GIF Video
VIDEO_PRORES 20 Apple ProRes 422HQ
Audio Codecs
AUDIO_NONE 0 No Audio
AUDIO_AAC 7 AAC Baseline
AUDIO_MP3 9 MP3 Standard
AUDIO_VORBIS 15 Vorbis Audio Cocec (WebM)

StreamParams

Type Name Description
VideoParams vparams A message that describes various aspects for the video stream
AudioParams aparams A message that describes various aspects for the audio stream
double min_client_buffer Minimum number of seconds in client buffer (Streaming only)

VideoParams

Type Name Description Default
uint32 width Width in pixel for the video stream
uint32 height Height in pixel for the video stream
Codec videocodec Video codec to use VIDEO_X264
Fractional videoframerate Frame rate of video (as fraction, e.g. 25/1, 30/1, 30000/1001 30/1
uint32 videobitrate Video bitrate in kilobits per second 2000
uint32 videoqp Quantization parameter (15..50) VRC_QUANTIZER 16
VideoRateControl videorc Method of rate control VRC_BITRATE
double videocpueffortc Encoder speed / Quality tradeoff
10 = low quality requirement, extremely fast
20 = general purpose good quality / fast preset
50 = good quality / medium speed preset
90 = very good quality / slow
100 = best quality / don't care about speed
10
EncoderDelayReq videodelayrequirement Quality / Latency tradeoff
DELAY_SMALL = keep reference frames
DELAY_REALTIME = do not keep reference frames
DELAY_SMALL
KeyValuePair [ ] videocodecextraparams Array of key-value pairs for extra codec settings
bool videotransparency Create video with transparent background (GIF) false

VideoRateControl

Enum Value Description
VRC_BITRATE 0 Control Bitrate
VRC_QUANTIZER 1 Control Quantization
VRC_RATEFACTOR 2 Control ratefactor

EncoderDelayReq

Enum Value Description
DELAY_REALTIME 1
DELAY_SMALL 2

AudioParams

Type Name Description Default
Codec audiocodec Audio codec to use AUDIO_NONE
uint32 audioabr Audio bitrate in kilobits per second 32000
uint32 audiosamplerate Number of audio samples per second 44100
uint32 channels Number of audio channels 2
uint32 audioframe_size Number of samples per audio frame 1024

Terms of Use | © 2017, Impossible Software, or its affiliates. All rights reserved.