1from fishjam._openapi_client.models import ( 2 PeerMetadata, 3 PeerStatus, 4 PeerType, 5 SubscribeOptions, 6 SubscribeOptionsAudioFormat, 7 SubscribeOptionsAudioSampleRate, 8) 9 10__all__ = [ 11 "PeerMetadata", 12 "PeerStatus", 13 "PeerType", 14 "SubscribeOptions", 15 "SubscribeOptionsAudioFormat", 16 "SubscribeOptionsAudioSampleRate", 17]
class
PeerMetadata:
11@_attrs_define 12class PeerMetadata: 13 """Custom metadata set by the peer 14 15 Example: 16 {'name': 'FishjamUser'} 17 18 """ 19 20 additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict) 21 22 def to_dict(self) -> dict[str, Any]: 23 field_dict: dict[str, Any] = {} 24 field_dict.update(self.additional_properties) 25 26 return field_dict 27 28 @classmethod 29 def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T: 30 d = dict(src_dict) 31 peer_metadata = cls() 32 33 peer_metadata.additional_properties = d 34 return peer_metadata 35 36 @property 37 def additional_keys(self) -> list[str]: 38 return list(self.additional_properties.keys()) 39 40 def __getitem__(self, key: str) -> Any: 41 return self.additional_properties[key] 42 43 def __setitem__(self, key: str, value: Any) -> None: 44 self.additional_properties[key] = value 45 46 def __delitem__(self, key: str) -> None: 47 del self.additional_properties[key] 48 49 def __contains__(self, key: str) -> bool: 50 return key in self.additional_properties
Custom metadata set by the peer
Example: {'name': 'FishjamUser'}
class
PeerStatus(builtins.str, enum.Enum):
5class PeerStatus(str, Enum): 6 """Informs about the peer status""" 7 8 CONNECTED = "connected" 9 DISCONNECTED = "disconnected" 10 11 def __str__(self) -> str: 12 return str(self.value)
Informs about the peer status
CONNECTED =
<PeerStatus.CONNECTED: 'connected'>
DISCONNECTED =
<PeerStatus.DISCONNECTED: 'disconnected'>
Inherited Members
- enum.Enum
- name
- value
- builtins.str
- encode
- replace
- split
- rsplit
- join
- capitalize
- casefold
- title
- center
- count
- expandtabs
- find
- partition
- index
- ljust
- lower
- lstrip
- rfind
- rindex
- rjust
- rstrip
- rpartition
- splitlines
- strip
- swapcase
- translate
- upper
- startswith
- endswith
- removeprefix
- removesuffix
- isascii
- islower
- isupper
- istitle
- isspace
- isdecimal
- isdigit
- isnumeric
- isalpha
- isalnum
- isidentifier
- isprintable
- zfill
- format
- format_map
- maketrans
class
PeerType(builtins.str, enum.Enum):
5class PeerType(str, Enum): 6 """Peer type""" 7 8 AGENT = "agent" 9 WEBRTC = "webrtc" 10 11 def __str__(self) -> str: 12 return str(self.value)
Peer type
AGENT =
<PeerType.AGENT: 'agent'>
WEBRTC =
<PeerType.WEBRTC: 'webrtc'>
Inherited Members
- enum.Enum
- name
- value
- builtins.str
- encode
- replace
- split
- rsplit
- join
- capitalize
- casefold
- title
- center
- count
- expandtabs
- find
- partition
- index
- ljust
- lower
- lstrip
- rfind
- rindex
- rjust
- rstrip
- rpartition
- splitlines
- strip
- swapcase
- translate
- upper
- startswith
- endswith
- removeprefix
- removesuffix
- isascii
- islower
- isupper
- istitle
- isspace
- isdecimal
- isdigit
- isnumeric
- isalpha
- isalnum
- isidentifier
- isprintable
- zfill
- format
- format_map
- maketrans
class
SubscribeOptions:
18@_attrs_define 19class SubscribeOptions: 20 """Configuration of server-side subscriptions to the peer's tracks 21 22 Example: 23 {'audioFormat': 'pcm16'} 24 25 Attributes: 26 audio_format (Union[Unset, SubscribeOptionsAudioFormat]): The format of the output audio Default: 27 SubscribeOptionsAudioFormat.PCM16. Example: pcm16. 28 audio_sample_rate (Union[Unset, SubscribeOptionsAudioSampleRate]): The sample rate of the output audio Default: 29 SubscribeOptionsAudioSampleRate.VALUE_16000. Example: 16000. 30 """ 31 32 audio_format: Union[ 33 Unset, SubscribeOptionsAudioFormat 34 ] = SubscribeOptionsAudioFormat.PCM16 35 audio_sample_rate: Union[ 36 Unset, SubscribeOptionsAudioSampleRate 37 ] = SubscribeOptionsAudioSampleRate.VALUE_16000 38 39 def to_dict(self) -> dict[str, Any]: 40 audio_format: Union[Unset, str] = UNSET 41 if not isinstance(self.audio_format, Unset): 42 audio_format = self.audio_format.value 43 44 audio_sample_rate: Union[Unset, int] = UNSET 45 if not isinstance(self.audio_sample_rate, Unset): 46 audio_sample_rate = self.audio_sample_rate.value 47 48 field_dict: dict[str, Any] = {} 49 50 field_dict.update({}) 51 if audio_format is not UNSET: 52 field_dict["audioFormat"] = audio_format 53 if audio_sample_rate is not UNSET: 54 field_dict["audioSampleRate"] = audio_sample_rate 55 56 return field_dict 57 58 @classmethod 59 def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T: 60 d = dict(src_dict) 61 _audio_format = d.pop("audioFormat", UNSET) 62 audio_format: Union[Unset, SubscribeOptionsAudioFormat] 63 if isinstance(_audio_format, Unset): 64 audio_format = UNSET 65 else: 66 audio_format = SubscribeOptionsAudioFormat(_audio_format) 67 68 _audio_sample_rate = d.pop("audioSampleRate", UNSET) 69 audio_sample_rate: Union[Unset, SubscribeOptionsAudioSampleRate] 70 if isinstance(_audio_sample_rate, Unset): 71 audio_sample_rate = UNSET 72 else: 73 audio_sample_rate = SubscribeOptionsAudioSampleRate(_audio_sample_rate) 74 75 subscribe_options = cls( 76 audio_format=audio_format, 77 audio_sample_rate=audio_sample_rate, 78 ) 79 80 return subscribe_options
Configuration of server-side subscriptions to the peer's tracks
Example: {'audioFormat': 'pcm16'}
Attributes: audio_format (Union[Unset, SubscribeOptionsAudioFormat]): The format of the output audio Default: SubscribeOptionsAudioFormat.PCM16. Example: pcm16. audio_sample_rate (Union[Unset, SubscribeOptionsAudioSampleRate]): The sample rate of the output audio Default: SubscribeOptionsAudioSampleRate.VALUE_16000. Example: 16000.
SubscribeOptions( audio_format: Union[fishjam._openapi_client.types.Unset, SubscribeOptionsAudioFormat] = <SubscribeOptionsAudioFormat.PCM16: 'pcm16'>, audio_sample_rate: Union[fishjam._openapi_client.types.Unset, SubscribeOptionsAudioSampleRate] = <SubscribeOptionsAudioSampleRate.VALUE_16000: 16000>)
2def __init__(self, audio_format=attr_dict['audio_format'].default, audio_sample_rate=attr_dict['audio_sample_rate'].default): 3 self.audio_format = audio_format 4 self.audio_sample_rate = audio_sample_rate
Method generated by attrs for class SubscribeOptions.
audio_format: Union[fishjam._openapi_client.types.Unset, SubscribeOptionsAudioFormat]
audio_sample_rate: Union[fishjam._openapi_client.types.Unset, SubscribeOptionsAudioSampleRate]
def
to_dict(self) -> dict[str, typing.Any]:
39 def to_dict(self) -> dict[str, Any]: 40 audio_format: Union[Unset, str] = UNSET 41 if not isinstance(self.audio_format, Unset): 42 audio_format = self.audio_format.value 43 44 audio_sample_rate: Union[Unset, int] = UNSET 45 if not isinstance(self.audio_sample_rate, Unset): 46 audio_sample_rate = self.audio_sample_rate.value 47 48 field_dict: dict[str, Any] = {} 49 50 field_dict.update({}) 51 if audio_format is not UNSET: 52 field_dict["audioFormat"] = audio_format 53 if audio_sample_rate is not UNSET: 54 field_dict["audioSampleRate"] = audio_sample_rate 55 56 return field_dict
@classmethod
def
from_dict(cls: type[~T], src_dict: Mapping[str, typing.Any]) -> ~T:
58 @classmethod 59 def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T: 60 d = dict(src_dict) 61 _audio_format = d.pop("audioFormat", UNSET) 62 audio_format: Union[Unset, SubscribeOptionsAudioFormat] 63 if isinstance(_audio_format, Unset): 64 audio_format = UNSET 65 else: 66 audio_format = SubscribeOptionsAudioFormat(_audio_format) 67 68 _audio_sample_rate = d.pop("audioSampleRate", UNSET) 69 audio_sample_rate: Union[Unset, SubscribeOptionsAudioSampleRate] 70 if isinstance(_audio_sample_rate, Unset): 71 audio_sample_rate = UNSET 72 else: 73 audio_sample_rate = SubscribeOptionsAudioSampleRate(_audio_sample_rate) 74 75 subscribe_options = cls( 76 audio_format=audio_format, 77 audio_sample_rate=audio_sample_rate, 78 ) 79 80 return subscribe_options
class
SubscribeOptionsAudioFormat(builtins.str, enum.Enum):
5class SubscribeOptionsAudioFormat(str, Enum): 6 """The format of the output audio""" 7 8 PCM16 = "pcm16" 9 10 def __str__(self) -> str: 11 return str(self.value)
The format of the output audio
PCM16 =
<SubscribeOptionsAudioFormat.PCM16: 'pcm16'>
Inherited Members
- enum.Enum
- name
- value
- builtins.str
- encode
- replace
- split
- rsplit
- join
- capitalize
- casefold
- title
- center
- count
- expandtabs
- find
- partition
- index
- ljust
- lower
- lstrip
- rfind
- rindex
- rjust
- rstrip
- rpartition
- splitlines
- strip
- swapcase
- translate
- upper
- startswith
- endswith
- removeprefix
- removesuffix
- isascii
- islower
- isupper
- istitle
- isspace
- isdecimal
- isdigit
- isnumeric
- isalpha
- isalnum
- isidentifier
- isprintable
- zfill
- format
- format_map
- maketrans
class
SubscribeOptionsAudioSampleRate(enum.IntEnum):
5class SubscribeOptionsAudioSampleRate(IntEnum): 6 VALUE_16000 = 16000 7 VALUE_24000 = 24000 8 9 def __str__(self) -> str: 10 return str(self.value)
VALUE_16000 =
<SubscribeOptionsAudioSampleRate.VALUE_16000: 16000>
VALUE_24000 =
<SubscribeOptionsAudioSampleRate.VALUE_24000: 24000>
Inherited Members
- enum.Enum
- name
- value
- builtins.int
- conjugate
- bit_length
- bit_count
- to_bytes
- from_bytes
- as_integer_ratio
- is_integer
- real
- imag
- numerator
- denominator