fishjam.recording
CompositionSource​
class CompositionSource:
Recording source coming from composition
Attributes:
- composition_url (str): URL of the composition to record
- output_id (str): Id of the output being recorded
- scale_ratio (float | Unset): Scale factor for the recording relative to the source output (>0; may upscale or downscale). Defaults to 1. Default: 1.0.
init​
def __init__( composition_url: 'str', output_id: 'str', scale_ratio: 'float | Unset' = 1.0 )
Method generated by attrs for class CompositionSource.
composition_url​
composition_url: 'str'
output_id​
output_id: 'str'
scale_ratio​
scale_ratio: 'float | Unset'
to_dict​
def to_dict(self) -> 'dict[str, Any]'
from_dict​
def from_dict(cls: 'type[T]', src_dict: 'Mapping[str, Any]') -> 'T'
Recording​
class Recording:
A recording and its current lifecycle status
Attributes:
- files (list[RecordingFile]): Media files of the recording, in playback order. Empty until the recording is
available. - id (str): Assigned recording id
- source (CompositionSource | TemplateSource): The source for the recording
- status (RecordingStatus): Lifecycle status of a recording
- metadata (None | RecordingMetadataType0 | Unset): Free-form, user-supplied metadata used to organize and filter recordings
init​
def __init__( files: 'list[RecordingFile]', id: 'str', source: 'CompositionSource | TemplateSource', status: 'RecordingStatus', metadata: 'None | RecordingMetadataType0 | Unset' = <Unset object> )
Method generated by attrs for class Recording.
files​
files: 'list[RecordingFile]'
id​
id: 'str'
source​
source: 'CompositionSource | TemplateSource'
status​
status: 'RecordingStatus'
metadata​
metadata: 'None | RecordingMetadataType0 | Unset'
additional_properties​
additional_properties: 'dict[str, Any]'
to_dict​
def to_dict(self) -> 'dict[str, Any]'
from_dict​
def from_dict(cls: 'type[T]', src_dict: 'Mapping[str, Any]') -> 'T'
additional_keys​
additional_keys: 'list[str]'
RecordingSource​
RecordingSource = CompositionSource | TemplateSource
What a recording captures, one member per source type.
RecordingStatus​
class RecordingStatus(str, enum.Enum):
Lifecycle status of a recording
ACTIVE​
ACTIVE = <RecordingStatus.ACTIVE: 'active'>
AVAILABLE​
AVAILABLE = <RecordingStatus.AVAILABLE: 'available'>
FAILED​
FAILED = <RecordingStatus.FAILED: 'failed'>
FINISHED​
FINISHED = <RecordingStatus.FINISHED: 'finished'>
Inherited Members​
- Enum:
namevalue
TemplateSource​
class TemplateSource:
Recording source that renders its own scene from a template, rather than cloning an existing output of the composition
- Attributes: composition_url (str): URL of the composition to record audio (bool | Unset): Whether the recording captures audio. Defaults to true. Default: True. resolution (TemplateSourceResolution | Unset): Resolution the scene is rendered at. Defaults to 1280x720.
init​
def __init__( composition_url: 'str', audio: 'bool | Unset' = True, resolution: 'TemplateSourceResolution | Unset' = <Unset object> )
Method generated by attrs for class TemplateSource.
composition_url​
composition_url: 'str'
audio​
audio: 'bool | Unset'
resolution​
resolution: 'TemplateSourceResolution | Unset'
to_dict​
def to_dict(self) -> 'dict[str, Any]'
from_dict​
def from_dict(cls: 'type[T]', src_dict: 'Mapping[str, Any]') -> 'T'
TemplateSourceResolution​
class TemplateSourceResolution:
Resolution the scene is rendered at. Defaults to 1280x720.
Attributes:
- height (int):
- width (int):
init​
def __init__(height: 'int', width: 'int')
Method generated by attrs for class TemplateSourceResolution.
height​
height: 'int'
width​
width: 'int'
to_dict​
def to_dict(self) -> 'dict[str, Any]'
from_dict​
def from_dict(cls: 'type[T]', src_dict: 'Mapping[str, Any]') -> 'T'