Item¶
-
class
vidispine.items.Item(client)¶ Items
Manage items.
-
create_placeholder(metadata: dict, params: Optional[dict] = None) → Dict[str, Any]¶ Creates a placeholder item.
- Parameters
params – Optional query parameters.
metadata – The metadata of the item.
- Returns
JSON response from the request.
- Return type
vidispine.typing.BaseJson.
-
delete(item_id: str) → None¶ Delete a single item.
- Parameters
item_id – The ID of the item.
-
get(item_id: str, params: Optional[dict] = None, metadata=True) → Dict[str, Any]¶ Returns information about a single item.
- Parameters
item_id – The ID of the item.
params – Optional query parameters.
metadata – Whether to return metadata or not.
- Returns
JSON response from the request.
- Return type
vidispine.typing.BaseJson.
-
import_to_placeholder(item_id: str, component_type: str, params: dict) → None¶ Import a file to a placeholder item.
- Parameters
item_id – The ID of the item.
component_type – The component type, can be: container, audio, video or binary.
params – Optional query parameters.
- Returns
JSON response from the request.
- Return type
vidispine.typing.BaseJson.
-
transcode(item_id: str, params: dict) → Dict[str, Any]¶ Starts a new job that transcodes an item into shape according to the given shape tags.
- Parameters
item_id – The ID of the item.
params – Optional query parameters.
- Returns
JSON response from the request.
- Return type
vidispine.typing.BaseJson.
-
Item Shape¶
-
class
vidispine.items.ItemShape(client)¶ Shapes
Manages shapes for an Item.
-
create(metadata: dict, item_id: str, params: Optional[dict] = None) → Dict[str, Any]¶ Creates a new shape using the supplied information.
- Parameters
metadata – Metadata (shape document) to create the shape with.
item_id – The ID of the item.
params – Optional query parameters.
- Returns
JSON response from the request.
- Return type
vidispine.typing.BaseJson.
-
delete(item_id: str, shape_id: str, params: Optional[dict] = None) → None¶ Removes the specified shape.
- Parameters
item_id – The ID of the item.
shape_id – The ID of the shape.
params – Optional query parameters.
-
delete_all(item_id: str, params: Optional[dict] = None) → None¶ Removes all shapes from an item.
- Parameters
item_id – The ID of the item.
params – Optional query parameters.
-
get(item_id: str, shape_id: str, params: Optional[dict] = None) → Dict[str, Any]¶ Returns a shape for a specified item.
- Parameters
item_id – The ID of the item.
shape_id – The ID of the shape.
params – Optional query parameters.
- Returns
JSON response from the request.
- Return type
vidispine.typing.BaseJson.
-
import_shape(item_id: str, params: dict) → None¶ Starts a new shape import job.
- Parameters
item_id – The ID of the item.
params – Optional query parameters.
- Returns
JSON response from the request.
- Return type
vidispine.typing.BaseJson.
-
list(item_id: str, params: Optional[dict] = None) → Dict[str, Any]¶ Returns all existing shapes for a specified item.
- Parameters
item_id – The ID of the item.
params – Optional query parameters.
- Returns
JSON response from the request.
- Return type
vidispine.typing.BaseJson.
-