Class MeetingSessionConfiguration

[[MeetingSessionConfiguration]] contains the information necessary to start a session.

Constructors

  • Constructs a MeetingSessionConfiguration optionally with a chime:CreateMeeting and chime:CreateAttendee response. You can pass in either a JSON object containing the responses, or a JSON object containing the information in the Meeting and Attendee root-level fields. Examples:

    const configuration = new MeetingSessionConfiguration({
    "Meeting": {
    "MeetingId": "...",
    "MediaPlacement": {
    "AudioHostUrl": "...",
    "SignalingUrl": "...",
    "TurnControlUrl": "..."
    },
    "MeetingFeatures":{
    "Audio":"...",
    "Video":"....",
    "Content":"...",
    "Attendee":"..."
    },
    }
    }
    }, {
    "Attendee": {
    "ExternalUserId": "...",
    "AttendeeId": "...",
    "JoinToken": "..."
    }
    });
    const configuration = new MeetingSessionConfiguration({
    "MeetingId": "...",
    "MediaPlacement": {
    "AudioHostUrl": "...",
    "SignalingUrl": "...",
    "TurnControlUrl": "..."
    }
    }, {
    "ExternalUserId": "...",
    "AttendeeId": "...",
    "JoinToken": "..."
    });

    Parameters

    • OptionalcreateMeetingResponse: any
    • OptionalcreateAttendeeResponse: any

    Returns MeetingSessionConfiguration

Properties

applicationMetadata: ApplicationMetadata

Builder's application metadata such as application name or version. This is an optional parameter. Please check [[ApplicationMetadata]] for more information.

attendeePresenceTimeoutMs: number

Maximum amount of time in milliseconds to wait for the current attendee to be present after initial connection.

connectionHealthPolicyConfiguration: ConnectionHealthPolicyConfiguration

Configuration for connection health policies: reconnection, unusable audio warning connection, and signal strength bars connection.

connectionTimeoutMs: number

Maximum amount of time in milliseconds to allow for connecting.

The credentials used to authenticate the session.

disablePeriodicKeyframeRequestOnContentSender: boolean

The Amazon Chime SDK media backends currently send a keyframe request to content share senders every 10 seconds to help mitigate decoder issues on receivers. This flag requests the backed to disable that feature.

Setting this flag to true may or may not lead to issues with content received for your application, as it depends on browsers used and whether they have fixed previous issues leading to the introduction of this periodic keyframe request. It will however reduce CPU consumption on content senders which no longer have to generate as many expensive keyframes.

enableSimulcastForUnifiedPlanChromiumBasedBrowsers: boolean

Feature flag to enable Simulcast

enableSVC: boolean

Feature flag to enable scalable video coding (SVC) on supported browsers, which is determined by BrowserBehavior.supportsScalableVideoCoding

externalMeetingId: string

The external meeting id of the meeting the session is joining.

keepLastFrameWhenPaused: boolean

Keep the last frame of the video when a remote video is paused via the pauseVideoTile API. This is done by not clearing the srcObject property of the videoElement.

meetingFeatures: MeetingFeatures

Additional features in the meeting

meetingId: string

The id of the meeting the session is joining.

reconnectFixedWaitMs: number

Fixed wait amount in milliseconds between reconnecting attempts.

reconnectLongBackOffMs: number

The long back-off time in milliseconds between reconnecting attempts.

reconnectShortBackOffMs: number

The short back-off time in milliseconds between reconnecting attempts.

reconnectTimeoutMs: number

Maximum amount of time in milliseconds to allow for reconnecting.

The URLs the session uses to reach the meeting service.

videoDownlinkBandwidthPolicy: VideoDownlinkBandwidthPolicy

Video downlink bandwidth policy to determine which remote videos are subscribed to.

videoUplinkBandwidthPolicy: VideoUplinkBandwidthPolicy

Video uplink bandwidth policy to determine the bandwidth constraints of the local video.