Skip to main content
Version: 0.24.0

fishjam.room

RoomConfig​

class RoomConfig:

Room configuration

Attributes:

  • max_peers (Union[None, Unset, int]): Maximum amount of peers allowed into the room Example: 10.
  • public (Union[Unset, bool]): True if livestream viewers can omit specifying a token. Default: False.
  • room_type (Union[Unset, RoomType]): The use-case of the room. If not provided, this defaults to conference.
  • video_codec (Union[Unset, VideoCodec]): Enforces video codec for each peer in the room
  • webhook_url (Union[None, Unset, str]): URL where Fishjam notifications will be sent Example: https://backend.address.com/fishjam-notifications-endpoint.

init​

def __init__(
    max_peers: Union[NoneType, Unset, int] = <Unset object>,
    public: Union[Unset, bool] = False,
    room_type: Union[Unset, RoomType] = <Unset object>,
    video_codec: Union[Unset, VideoCodec] = <Unset object>,
    webhook_url: Union[NoneType, Unset, str] = <Unset object>
)

Method generated by attrs for class RoomConfig.

max_peers​

max_peers: Union[NoneType, Unset, int]

public​

public: Union[Unset, bool]

room_type​

room_type: Union[Unset, RoomType]

video_codec​

video_codec: Union[Unset, VideoCodec]

webhook_url​

webhook_url: Union[NoneType, Unset, str]

additional_properties​

additional_properties: dict[str, typing.Any]

to_dict​

def to_dict(self) -> dict[str, typing.Any]

from_dict​

def from_dict(cls: type[~T], src_dict: Mapping[str, typing.Any]) -> ~T

additional_keys​

additional_keys: list[str]

VideoCodec​

class VideoCodec(str, enum.Enum):

Enforces video codec for each peer in the room

H264​

H264 = <VideoCodec.H264: 'h264'>

VP8​

VP8 = <VideoCodec.VP8: 'vp8'>

Inherited Members​

  • Enum:
    • name
    • value

RoomType​

class RoomType(str, enum.Enum):

The use-case of the room. If not provided, this defaults to conference.

AUDIO_ONLY​

AUDIO_ONLY = <RoomType.AUDIO_ONLY: 'audio_only'>

AUDIO_ONLY_LIVESTREAM​

AUDIO_ONLY_LIVESTREAM = <RoomType.AUDIO_ONLY_LIVESTREAM: 'audio_only_livestream'>

BROADCASTER​

BROADCASTER = <RoomType.BROADCASTER: 'broadcaster'>

CONFERENCE​

CONFERENCE = <RoomType.CONFERENCE: 'conference'>

FULL_FEATURE​

FULL_FEATURE = <RoomType.FULL_FEATURE: 'full_feature'>

LIVESTREAM​

LIVESTREAM = <RoomType.LIVESTREAM: 'livestream'>

Inherited Members​

  • Enum:
    • name
    • value