Skip to main content
Version: 0.23.0

fishjam.events

ServerMessageRoomCreated​

class ServerMessageRoomCreated(betterproto.Message):

Notification sent when a room is created

init​

def __init__(room_id: str = <object object>)

room_id​

room_id: str

Inherited Members​

  • Message:
    • SerializeToString
    • parse
    • FromString
    • to_dict
    • from_dict
    • to_json
    • from_json
    • to_pydict
    • from_pydict
    • is_set

ServerMessageRoomDeleted​

class ServerMessageRoomDeleted(betterproto.Message):

Notification sent when a room is deleted

init​

def __init__(room_id: str = <object object>)

room_id​

room_id: str

Inherited Members​

  • Message:
    • SerializeToString
    • parse
    • FromString
    • to_dict
    • from_dict
    • to_json
    • from_json
    • to_pydict
    • from_pydict
    • is_set

ServerMessageRoomCrashed​

class ServerMessageRoomCrashed(betterproto.Message):

Notification sent when a room crashes

init​

def __init__(room_id: str = <object object>)

room_id​

room_id: str

Inherited Members​

  • Message:
    • SerializeToString
    • parse
    • FromString
    • to_dict
    • from_dict
    • to_json
    • from_json
    • to_pydict
    • from_pydict
    • is_set

ServerMessagePeerAdded​

class ServerMessagePeerAdded(betterproto.Message):

Notification sent when a peer is added

init​

def __init__(
    room_id: str = <object object>,
    peer_id: str = <object object>,
    peer_type: ServerMessagePeerType = <object object>
)

room_id​

room_id: str

peer_id​

peer_id: str

peer_type​

peer_type: ServerMessagePeerType

Inherited Members​

  • Message:
    • SerializeToString
    • parse
    • FromString
    • to_dict
    • from_dict
    • to_json
    • from_json
    • to_pydict
    • from_pydict
    • is_set

ServerMessagePeerConnected​

class ServerMessagePeerConnected(betterproto.Message):

Notification sent when a peer connects

init​

def __init__(
    room_id: str = <object object>,
    peer_id: str = <object object>,
    peer_type: ServerMessagePeerType = <object object>
)

room_id​

room_id: str

peer_id​

peer_id: str

peer_type​

peer_type: ServerMessagePeerType

Inherited Members​

  • Message:
    • SerializeToString
    • parse
    • FromString
    • to_dict
    • from_dict
    • to_json
    • from_json
    • to_pydict
    • from_pydict
    • is_set

ServerMessagePeerDeleted​

class ServerMessagePeerDeleted(betterproto.Message):

Notification sent when a peer is removed

init​

def __init__(
    room_id: str = <object object>,
    peer_id: str = <object object>,
    peer_type: ServerMessagePeerType = <object object>
)

room_id​

room_id: str

peer_id​

peer_id: str

peer_type​

peer_type: ServerMessagePeerType

Inherited Members​

  • Message:
    • SerializeToString
    • parse
    • FromString
    • to_dict
    • from_dict
    • to_json
    • from_json
    • to_pydict
    • from_pydict
    • is_set

ServerMessagePeerDisconnected​

class ServerMessagePeerDisconnected(betterproto.Message):

Notification sent when a peer disconnects from FJ

init​

def __init__(
    room_id: str = <object object>,
    peer_id: str = <object object>,
    peer_type: ServerMessagePeerType = <object object>
)

room_id​

room_id: str

peer_id​

peer_id: str

peer_type​

peer_type: ServerMessagePeerType

Inherited Members​

  • Message:
    • SerializeToString
    • parse
    • FromString
    • to_dict
    • from_dict
    • to_json
    • from_json
    • to_pydict
    • from_pydict
    • is_set

ServerMessagePeerMetadataUpdated​

class ServerMessagePeerMetadataUpdated(betterproto.Message):

Notification sent when peer updates its metadata

init​

def __init__(
    room_id: str = <object object>,
    peer_id: str = <object object>,
    metadata: str = <object object>,
    peer_type: ServerMessagePeerType = <object object>
)

room_id​

room_id: str

peer_id​

peer_id: str

metadata​

metadata: str

peer_type​

peer_type: ServerMessagePeerType

Inherited Members​

  • Message:
    • SerializeToString
    • parse
    • FromString
    • to_dict
    • from_dict
    • to_json
    • from_json
    • to_pydict
    • from_pydict
    • is_set

ServerMessagePeerCrashed​

class ServerMessagePeerCrashed(betterproto.Message):

Notification sent when a peer crashes

init​

def __init__(
    room_id: str = <object object>,
    peer_id: str = <object object>,
    reason: str = <object object>,
    peer_type: ServerMessagePeerType = <object object>
)

room_id​

room_id: str

peer_id​

peer_id: str

reason​

reason: str

peer_type​

peer_type: ServerMessagePeerType

Inherited Members​

  • Message:
    • SerializeToString
    • parse
    • FromString
    • to_dict
    • from_dict
    • to_json
    • from_json
    • to_pydict
    • from_pydict
    • is_set

ServerMessageStreamConnected​

class ServerMessageStreamConnected(betterproto.Message):

Notification sent when streamer successfully connects

init​

def __init__(stream_id: str = <object object>)

stream_id​

stream_id: str

Inherited Members​

  • Message:
    • SerializeToString
    • parse
    • FromString
    • to_dict
    • from_dict
    • to_json
    • from_json
    • to_pydict
    • from_pydict
    • is_set

ServerMessageStreamDisconnected​

class ServerMessageStreamDisconnected(betterproto.Message):

Notification sent when streamer disconnects

init​

def __init__(stream_id: str = <object object>)

stream_id​

stream_id: str

Inherited Members​

  • Message:
    • SerializeToString
    • parse
    • FromString
    • to_dict
    • from_dict
    • to_json
    • from_json
    • to_pydict
    • from_pydict
    • is_set

ServerMessageTrackAdded​

class ServerMessageTrackAdded(betterproto.Message):

Notification sent when peer or component adds new track

init​

def __init__(
    room_id: str = <object object>,
    peer_id: str = <object object>,
    component_id: str = <object object>,
    track: Track = <object object>
)

room_id​

room_id: str

peer_id​

peer_id: str

component_id​

component_id: str

track​

track: Track

Inherited Members​

  • Message:
    • SerializeToString
    • parse
    • FromString
    • to_dict
    • from_dict
    • to_json
    • from_json
    • to_pydict
    • from_pydict
    • is_set

ServerMessageTrackMetadataUpdated​

class ServerMessageTrackMetadataUpdated(betterproto.Message):

Notification sent when metadata of a multimedia track is updated

init​

def __init__(
    room_id: str = <object object>,
    peer_id: str = <object object>,
    component_id: str = <object object>,
    track: Track = <object object>
)

room_id​

room_id: str

peer_id​

peer_id: str

component_id​

component_id: str

track​

track: Track

Inherited Members​

  • Message:
    • SerializeToString
    • parse
    • FromString
    • to_dict
    • from_dict
    • to_json
    • from_json
    • to_pydict
    • from_pydict
    • is_set

ServerMessageTrackRemoved​

class ServerMessageTrackRemoved(betterproto.Message):

Notification sent when a track is removed

init​

def __init__(
    room_id: str = <object object>,
    peer_id: str = <object object>,
    component_id: str = <object object>,
    track: Track = <object object>
)

room_id​

room_id: str

peer_id​

peer_id: str

component_id​

component_id: str

track​

track: Track

Inherited Members​

  • Message:
    • SerializeToString
    • parse
    • FromString
    • to_dict
    • from_dict
    • to_json
    • from_json
    • to_pydict
    • from_pydict
    • is_set

ServerMessageViewerConnected​

class ServerMessageViewerConnected(betterproto.Message):

Notification sent when viewer successfully connects

init​

def __init__(stream_id: str = <object object>, viewer_id: str = <object object>)

stream_id​

stream_id: str

viewer_id​

viewer_id: str

Inherited Members​

  • Message:
    • SerializeToString
    • parse
    • FromString
    • to_dict
    • from_dict
    • to_json
    • from_json
    • to_pydict
    • from_pydict
    • is_set

ServerMessageViewerDisconnected​

class ServerMessageViewerDisconnected(betterproto.Message):

Notification sent when viewer disconnects

init​

def __init__(stream_id: str = <object object>, viewer_id: str = <object object>)

stream_id​

stream_id: str

viewer_id​

viewer_id: str

Inherited Members​

  • Message:
    • SerializeToString
    • parse
    • FromString
    • to_dict
    • from_dict
    • to_json
    • from_json
    • to_pydict
    • from_pydict
    • is_set

Track​

class Track(betterproto.Message):

Describes a media track

init​

def __init__(
    id: str = <object object>,
    type: TrackType = <object object>,
    metadata: str = <object object>
)

id​

id: str

type​

type: TrackType

metadata​

metadata: str

Inherited Members​

  • Message:
    • SerializeToString
    • parse
    • FromString
    • to_dict
    • from_dict
    • to_json
    • from_json
    • to_pydict
    • from_pydict
    • is_set

TrackEncoding​

class TrackEncoding(betterproto.Enum):

The base class for protobuf enumerations, all generated enumerations will inherit from this. Bases :class:enum.IntEnum.

TRACK_ENCODING_UNSPECIFIED​

TRACK_ENCODING_UNSPECIFIED = <TrackEncoding.TRACK_ENCODING_UNSPECIFIED: 0>

TRACK_ENCODING_PCM16​

TRACK_ENCODING_PCM16 = <TrackEncoding.TRACK_ENCODING_PCM16: 1>

TRACK_ENCODING_OPUS​

TRACK_ENCODING_OPUS = <TrackEncoding.TRACK_ENCODING_OPUS: 2>

Inherited Members​

  • Enum:

    • from_string

  • Enum:

    • name
    • value

TrackType​

class TrackType(betterproto.Enum):

Defines types of tracks being published by peers and component

TRACK_TYPE_UNSPECIFIED​

TRACK_TYPE_UNSPECIFIED = <TrackType.TRACK_TYPE_UNSPECIFIED: 0>

TRACK_TYPE_VIDEO​

TRACK_TYPE_VIDEO = <TrackType.TRACK_TYPE_VIDEO: 1>

TRACK_TYPE_AUDIO​

TRACK_TYPE_AUDIO = <TrackType.TRACK_TYPE_AUDIO: 2>

Inherited Members​

  • Enum:

    • from_string

  • Enum:

    • name
    • value

ServerMessagePeerType​

class ServerMessagePeerType(betterproto.Enum):

The base class for protobuf enumerations, all generated enumerations will inherit from this. Bases :class:enum.IntEnum.

PEER_TYPE_UNSPECIFIED​

PEER_TYPE_UNSPECIFIED = <ServerMessagePeerType.PEER_TYPE_UNSPECIFIED: 0>

PEER_TYPE_WEBRTC​

PEER_TYPE_WEBRTC = <ServerMessagePeerType.PEER_TYPE_WEBRTC: 1>

PEER_TYPE_AGENT​

PEER_TYPE_AGENT = <ServerMessagePeerType.PEER_TYPE_AGENT: 2>

Inherited Members​

  • Enum:

    • from_string

  • Enum:

    • name
    • value