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

  • There are 2 types of modes:

    • CONFERENCE: Both audio and video streams will be produced and consumed in this mode.

    • VIEWER: Audio and video streams will not be produced or consumed in this mode.

    • defaultValue : CONFERENCE

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

preferred_protocol​

  • OPTIONAL

  • There are 3 types of protocol:

    • UDP_OVER_TCP: Initially the server attempts to establish a connection using UDP, if that fails it automatically switches to TCP protocol.
    • UDP_ONLY: Force UDP protocol
    • TCP_ONLY: Force TCP protocol
    • defaultValue : UDP_OVER_TCP

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?