MovieClip(ID)

base classes — bpy_struct, ID

class bpy.types.MovieClip(ID)

MovieClip data-block referencing an external movie file

animation_data

Animation data for this data-block (readonly)

Type:

AnimData

annotation

Annotation data for this movie clip

Type:

Annotation

colorspace_settings

Input color space settings (readonly)

Type:

ColorManagedInputColorspaceSettings

display_aspect

Display Aspect for this clip, does not affect rendering (array of 2 items, in [0.1, inf], default (1.0, 1.0))

Type:

mathutils.Vector

filepath

Filename of the movie or sequence file (default “”, never None, blend relative // prefix supported)

Type:

str

fps

Detected frame rate of the movie clip in frames per second (in [-inf, inf], default 0.0, readonly)

Type:

float

frame_duration

Detected duration of movie clip in frames (in [-inf, inf], default 0, readonly)

Type:

int

frame_offset

Offset of footage first frame relative to its file name (affects only how footage is loading, does not change data associated with a clip) (in [-inf, inf], default 0)

Type:

int

frame_start

Global scene frame number at which this movie starts playing (affects all data associated with a clip) (in [-inf, inf], default 1)

Type:

int

proxy

(readonly)

Type:

MovieClipProxy

size

Width and height in pixels, zero when image data cannot be loaded (array of 2 items, in [-inf, inf], default (0, 0), readonly)

Type:

bpy_prop_array[int]

source

Where the clip comes from (default 'SEQUENCE', readonly)

  • SEQUENCE Image Sequence – Multiple image files, as a sequence.

  • MOVIE Movie File – Movie file.

Type:

Literal[‘SEQUENCE’, ‘MOVIE’]

tracking

(readonly)

Type:

MovieTracking

use_proxy

Use a preview proxy and/or timecode index for this clip (default False)

Type:

bool

use_proxy_custom_directory

Create proxy images in a custom directory (default is movie location) (default False)

Type:

bool

metadata()

Retrieve metadata of the movie file

Returns:

Dict-like object containing the metadata

Return type:

IDPropertyWrapPtr

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

  • id (str) – The RNA type identifier.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References