Skip to content

Sources

TakeSourceKey

Choices for take source keys.

mp4 class-attribute instance-attribute 

mp4 = 'MP4'

avi class-attribute instance-attribute 

avi = 'AVI'

mov class-attribute instance-attribute 

mov = 'MOV'

move class-attribute instance-attribute 

move = 'MOVE'

CameraSettings

Camera settings input for creating a take.

Find the list of available camera settings here: https://move-ai.github.io/move-ugc-api/getting-started/multicam/lenses/

lens class-attribute instance-attribute 

lens: str = Field(description='Lens used for the take', title='Lens', examples=['goprohero10-2-7k', 'blackmagic-ea-4k-24mm', 'sony-synced-fhd', 'panasonic-lumix-dc-bgh1-4k-12mm', 'optitrackprimecolor12mm-fhd'])

ClipWindow

Clip window for cropping a source.

start_time class-attribute instance-attribute 

start_time: float = Field(description='Start time of the clip window', title='Start time', examples=[0], serialization_alias='startTime')

end_time class-attribute instance-attribute 

end_time: float = Field(description='End time of the clip window', title='End time', examples=[10.0], serialization_alias='endTime')

AdditionalFileType

Representation for Additional File type in MoveUGC.

key class-attribute instance-attribute 

key: str = Field(description='Identification key for the additional file', title='Additional file key', examples=['mp4', 'depth', 'odometry', 'vision', 'intrinsic'])

file class-attribute instance-attribute 

file: FileType = Field(description='File associated with the additional file', title='Additional file', examples=[{'id': 'file-2c6059be-0f91-4cb8-aa1a-512cd10a66b5'}])

SourceIn

Source input required for creating a take.

device_label class-attribute instance-attribute 

device_label: str = Field(description='Label for the device', title='Device label', examples=['my-device'], serialization_alias='deviceLabel')

file_id class-attribute instance-attribute 

file_id: str = Field(description='File ID of the file associated with the source', title='File ID', examples=['file-2c6059be-0f91-4cb8-aa1a-512cd10a66b5'], serialization_alias='fileId')

format class-attribute instance-attribute 

format: TakeSourceKey = Field(description='Format of the source', title='Source format', examples=['MP4', 'MOVE'])

camera_settings class-attribute instance-attribute 

camera_settings: Optional[CameraSettings] = Field(description='Camera settings used for the take', title='Camera settings', examples=[{'lens': 'goprohero10-2-7k'}], serialization_alias='cameraSettings', default=None)

clip_window class-attribute instance-attribute 

clip_window: Optional[ClipWindow] = Field(description='Clip window for cropping the source', title='Clip window', examples=[{'startTime': 0, 'endTime': 10}], serialization_alias='clipWindow', default=None)

Source

Representation for Source type in MoveUGC.

device_label class-attribute instance-attribute 

device_label: str = Field(description='Label for the device', examples=['my-device'], title='Device label', alias='deviceLabel')

file class-attribute instance-attribute 

file: FileType = Field(description='File associated with the source', examples=[{'id': 'file-1fd863d5-875b-4e48-89bb-c6234e804738'}], title='Source file')

format class-attribute instance-attribute 

format: str = Field(description='Format of the source', examples=['MP4'], title='Source format')

camera_settings class-attribute instance-attribute 

camera_settings: Optional[CameraSettings] = Field(description='Camera settings used for the take', title='Camera settings', examples=[{'lens': 'goprohero10-2-7k'}], serialization_alias='cameraSettings', default=None)

clip_window class-attribute instance-attribute 

clip_window: Optional[ClipWindow] = Field(description='Clip window for the source', title='Clip window', examples=[{'startTime': 0, 'endTime': 10}], default=None)