Shape Tags¶
-
class
vidispine.shape_tag.ShapeTag(client)¶ Shape tags
Manage shape tags.
-
create(shape_tag_name: str, metadata: dict) → None¶ Creates a new shape tag with the given tag name.
- Parameters
shape_tag_name – The name of the shape tag to create.
metadata – The metadata (transcode preset document) to create the shape tag with.
-
delete(shape_tag_name: str) → None¶ Deletes a shape tag with the given tag name.
- Parameters
shape_tag_name – The name of the shape tag to delete.
-
get(shape_tag_name: str) → Dict[str, Any]¶ - Retrieves the metadata (transcode preset) of a shape tag with
the given tag name.
- Parameters
shape_tag_name – The name of the shape tag.
- Returns
JSON response from the request.
- Return type
vidispine.typing.BaseJson.
-
list(params: Optional[dict] = None) → Dict[str, Any]¶ Retrieves all shape tags known by the system.
- Parameters
params – Optional query params.
- Returns
JSON response from the request.
- Return type
vidispine.typing.BaseJson.
-
update(shape_tag_name: str, metadata: dict) → None¶ Updates a shape tag with the given tag name.
- Parameters
shape_tag_name – The name of the shape tag to update.
metadata – The metadata (transcode preset document) to update the shape tag with.
-