Types - Python | VideoSDK

MeetingConfig

Parameter	Description	Type	Required	Default Value
meeting_id	Unique Id of the meeting where that participant will be joining.	str	Yes	-
name	Name of the participant who will be joining the meeting, this name will be displayed to other participants in the same meeting.	str	Yes	-
mic_enabled	Whether mic of the participant will be on while joining the meeting. If set to false, mic will be disabled by default but can be changed later.	bool	Yes	-
webcam_enabled	Whether webcam of the participant will be on while joining the meeting. If set to false, webcam will be disabled by default but can be changed later.	bool	Yes	-
token	The auth token generated from your server.	str	Yes	-
participant_id	Custom participant ID.	str	No	-
custom_camera_video_track	Set the initial custom video track using different encoding parameters, camera facing mode, and optimization mode.	MediaStreamTrack	No	-
custom_microphone_audio_track	Set the initial custom audio track using different encoding parameters and optimization mode.	MediaStreamTrack	No	-
mode	Mode of the meeting. CONFERENCE produces and consumes audio/video streams. VIEWER does not.	str	No	CONFERENCE
meta_data	Additional details about a user joining a meeting, such as their profile image.	Dict	No	-
preferred_protocol	Preferred protocol: UDP_OVER_TCP attempts UDP first, then TCP; UDP_ONLY forces UDP; TCP_ONLY forces TCP.	str	No	UDP_OVER_TCP
signaling_base_url	Proxy URL to origin signaling and media.	str	No	-

You can use this table to quickly reference the parameters and their details for configuring a meeting using MeetingConfig.

Example

Meeting Config

  from videosdk import MeetingConfig
  meeting_config = MeetingConfig(
    meeting_id=MEETING_ID,
    name=NAME,
    mic_enabled=True,
    webcam_enabled=True,
    token=VIDEOSDK_TOKEN
  )
  meeting = VideoSDK.init_meeting(**meeting_config)

PubSubPublishConfig

Parameter	Description	Type	Required	Default Value
topic	The topic under which the message will be published.	str	Yes	-
message	The message to be published under the specified topic.	str	Yes	-
options	Options for publish.	dict	No	-
payload	Additional data or details to be included with the message.	dict	No	-

options

Parameter	Description	Type	Required	Default Value
persist	Whether the message should be persisted or not. If true, the message will be stored persistently.	bool	No	false

Sure, here are the definitions in the form of Markdown tables:

PubSubSubscribeConfig

Parameter	Description	Type	Required	Default Value
topic	The topic to subscribe to.	str	Yes	-
cb	The callback function to handle messages for this topic.	Callable	Yes	-

SummaryConfig

Parameter	Description	Type	Required	Default Value
enabled	Whether summary is enabled or not.	bool	No	False
prompt	An optional string prompt to customize the summary.	Optional[str]	No	None

TranscriptionConfig

Parameter	Description	Type	Required	Default Value
webhook_url	The URL for the webhook to send transcription updates.	Optional[str]	No	None
summary	Configuration for generating a summary.	Optional[SummaryConfig]	No	None

PostTranscriptionConfig

Parameter	Description	Type	Required	Default Value
enabled	Whether post-transcription processing is enabled.	Optional[bool]	No	False
summary	Configuration for generating a summary.	Optional[SummaryConfig]	No	None

RecordingConfig

Parameter	Description	Type	Required	Default Value
dir_path	The directory path where recordings will be stored.	Optional[str]	No	None
transcription	Configuration for post-transcription processing.	Optional[PostTranscriptionConfig]	No	None
config	Additional configuration options for recording.	Optional[Dict[str, Any]]	No	None
webhook_url	The URL for the webhook to send recording updates.	Optional[str]	No	None