Takes

TakeService

Service which can be used to communicate with Take type in UGC API.

To use this service, you need to instantiate it with a valid Move UGC client.

from move_ugc import MoveUgc
ugc = MoveUgc(api_key="my-api-key")

# Call take service methods directly
ugc.takes.retrieve(id="take-<guid>")

# Or use the take service as a mixin
take_service = ugc.takes
take_service.retrieve(id="take-<guid>")

create_singlecam

create_singlecam(sources: List[SourceIn], name: Optional[str] = '', metadata: Optional[Dict[str, Any]] = None, expand: Optional[List[ALLOWED_EXPAND_ATTRS]] = None) -> TakeType

Create a singlecam take with given sources in MoveUGC.

Parameters:

Name	Type	Description	Default
sources	List[SourceIn]	list of sources to be used for creating the take.	required
name	Optional[str]	name to be used for creating the take.	''
metadata	Optional[Dict[str, Any]]	metadata to be used for creating the take. This should be a valid json string.	None
expand	Optional[List[ALLOWED_EXPAND_ATTRS]]	list of fields to be expanded. Currently only client and sources are supported.	None

Returns:

Type	Description
TakeType	File instance of Pydantic model type.

create_multicam

create_multicam(sources: List[SourceIn], volume_id: str, name: Optional[str] = '', sync_method: Optional[SyncMethodInput] = None, metadata: Optional[Dict[str, Any]] = None, expand: Optional[List[ALLOWED_EXPAND_ATTRS]] = None) -> TakeType

Create a multicam take with given sources in MoveUGC.

Parameters:

Name	Type	Description	Default
sources	List[SourceIn]	list of sources to be used for creating the take.	required
volume_id	str	unique identifier for the volume. This should typically be something like volume-{uuid}.	required
name	Optional[str]	name to be used for creating the take.	''
sync_method	Optional[SyncMethodInput]	sync method to be used for creating the take.	None
metadata	Optional[Dict[str, Any]]	metadata to be used for creating the take. This should be a valid json string.	None
expand	Optional[List[ALLOWED_EXPAND_ATTRS]]	list of fields to be expanded. Currently only client and sources are supported.	None

Returns:

Type	Description
TakeType	File instance of Pydantic model type.

retrieve

retrieve(id: str, expand: Optional[List[ALLOWED_EXPAND_ATTRS]] = None) -> TakeType

Retrieve a take with given take_id from MoveUGC.

The unique id for take will usually be in the format: take-{uuid}

Parameters:

Name	Type	Description	Default
id	str	unique identifier for the take. This should typically be something like take-{uuid}.	required
expand	Optional[List[ALLOWED_EXPAND_ATTRS]]	list of fields to be expanded. Currently only client and sources are supported.	None

Returns:

Type	Description
TakeType	Take instance of Pydantic model type.

list

list(limit: Optional[int] = None, next_token: Optional[str] = None, sort_by: SortDirection = SortDirection.DESC, expand: Optional[List[ALLOWED_EXPAND_ATTRS]] = None) -> ListBase

List takes in MoveUGC.

Parameters:

Name	Type	Description	Default
limit	Optional[int]	limit the number of items to be returned.	None
next_token	Optional[str]	next token to be used for pagination.	None
sort_by	SortDirection	sort order for the list.	DESC
expand	Optional[List[ALLOWED_EXPAND_ATTRS]]	list of fields to be expanded. Currently only client and sources are supported.	None

Returns:

Name	Type	Description
ListBase	ListBase	List of Take instances of Pydantic model type.

update

update(id: str, name: Optional[str] = None, metadata: Optional[Dict[str, Any]] = None, expand: Optional[List[ALLOWED_EXPAND_ATTRS]] = None) -> TakeType

Update a take with given take_id in MoveUGC.

Parameters:

Name	Type	Description	Default
id	str	unique identifier for the take. This should typically be something like take-{uuid}.	required
name	Optional[str]	name of the take	None
metadata	Optional[Dict[str, Any]]	metadata to be used for updating the take. This should be a valid json string.	None
expand	Optional[List[ALLOWED_EXPAND_ATTRS]]	list of fields to be expanded. Currently only client and sources are supported.	None

Returns:

Type	Description
TakeType	Take instance of Pydantic model type.