Skip to main content
Version: 0.0.x

MeetingConfig - Python

MeetingConfig dataclass simplifies configuration of meeting.

note

dataclass is decorater for user-defined classes, it was originally described in pep-0557

Meeting Config​

Meeting Config
  from videosdk import MeetingConfig
  meeting_config = MeetingConfig(
    meeting_id=MEETING_ID,
    name=NAME,
    mic_enabled=True,
    webcam_enabled=True,
    token=VIDEOSDK_TOKEN
  )

MeetingConfig Parameters​

meeting_id​

  • Unique Id of the meeting where that participant will be joining.

    • type : str
    • REQUIRED

Please refer this documentation to create a room.

name​

  • Name of the participant who will be joining the meeting, this name will be displayed to other participants in the same meeting.

    • type : str
    • REQUIRED

mic_enabled​

  • Whether mic of the participant will be on while joining the meeting. If it is set to false, then mic of that participant will be disabled by default, but can be enabled or disabled later.

    • type: bool
    • REQUIRED

webcam_enabled​

  • Whether webcam of the participant will be on while joining the meeting. If it is set to false, then webcam of that participant will be disabled by default, but can be enabled or disabled later.

    • type: bool
    • REQUIRED

token​

  • The auth token generated from your server.

    • type: str
    • REQUIRED

Please refer this documentation to generate a token.

participant_id​

  • You can specify your custom participantId here.

    • type: str
    • OPTIONAL

custom_camera_video_track​

  • Set the initial custom video track using different encoding parameters, camera facing mode, and optimization mode.

    • type: MediaStreamTrack
    • OPTIONAL

custom_microphone_audio_track​

  • Set the initial custom audio track using different encoding parameters and optimization mode.

    • type: MediaStreamTrack
    • OPTIONAL

mode​

  • OPTIONAL

  • Controls whether the participant sends and/or receives media:

    • SEND_AND_RECV: Produce and consume media (audio and video). This is the default.

    • RECV_ONLY: Only consume media; the participant does not produce audio or video.

    • SIGNALLING_ONLY: Neither produce nor consume media, for signalling-only participants.

    • defaultValue : SEND_AND_RECV

note

CONFERENCE and VIEWER are deprecated. Use SEND_AND_RECV and RECV_ONLY instead.

meta_data​

  • If you want to provide additional details about a user joining a meeting, such as their profile image, you can pass that information in this parameter.

    • type: Dict
    • OPTIONAL

auto_consume​

  • Whether the participant automatically consumes (receives) other participants' media streams. When set to false, you consume streams manually.

    • type: bool
    • defaultValue : true
    • OPTIONAL

chat_enabled​

  • Whether the data channel used for chat and meeting.send(...) messaging is enabled for this participant.

    • type: bool
    • defaultValue : true
    • OPTIONAL

debug_mode​

  • Whether SDK debug logging is enabled.

    • type: bool
    • defaultValue : true
    • OPTIONAL

preferred_protocol​

  • OPTIONAL

  • There are 2 types of protocol:

    • UDP_ONLY: Force the UDP protocol. This is the default.

    • UDP_OVER_TCP: Attempt UDP first, and fall back to TCP if UDP fails.

    • defaultValue : UDP_ONLY

signaling_base_url​

  • Proxy URL to origin signaling and media.

    • type: str
    • OPTIONAL

Got a Question? Ask us on discord

Last updated on by Ankit3110200

Was this helpful?