Справка по DesktopCapturerPlugin:Renderer

Обновлено 19 февраля 2025

Псевдонимы типов

JazzSdkAskForMediaAccessType

Ƭ JazzSdkAskForMediaAccessType: "microphone" | "camera"

---

JazzSdkDesktopCapturerEvent

Ƭ JazzSdkDesktopCapturerEvent: JazzSdkDesktopCapturerEventSelectDesktopSource | JazzSdkDesktopCapturerEventCancel | JazzSdkDesktopCapturerEventUpdateSources | JazzSdkDesktopCapturerEventStartProcess | JazzSdkDesktopCapturerEventFinishProcess | JazzSdkDesktopCapturerEventSources

---

JazzSdkDesktopCapturerEventCancel

Ƭ JazzSdkDesktopCapturerEventCancel: Object

Декларация типа

Name	Type
payload	{ action: "cancel" }
payload.action	"cancel"
type	"cancel"

---

JazzSdkDesktopCapturerEventSelectDesktopSource

Ƭ JazzSdkDesktopCapturerEventSelectDesktopSource: Object

Декларация типа

Name	Type
payload	{ source: JazzSdkDesktopCapturerSource }
payload.source	JazzSdkDesktopCapturerSource
type	"selectDesktopSource"

---

JazzSdkDesktopCapturerOptions

Ƭ JazzSdkDesktopCapturerOptions: Readonly\<{ images: JazzSdkDesktopCapturerOptionImages ; types: ("window" | "screen")[] }>

---

JazzSdkDesktopCapturerService

Ƭ JazzSdkDesktopCapturerService: Object

Декларация типа

Name	Type
accessStatus	Query\<JazzSdkMediaAccessStatus | undefined>
cancel	() => void
event$	Observable\<JazzSdkDesktopCapturerEvent>
getMediaAccessStatus	(type: JazzSdkMediaAccessType) => Promise\<JazzSdkMediaAccessStatus>
openSystemSettings	(type: JazzSdkSystemSettingsKey) => Promise\<void>
requestDesktopMediaAccess	(type: MediaType) => Promise\<JazzSdkMediaAccessStatus>
selectSource	(source: JazzSdkDesktopCapturerSource) => void
sources	Query\<JazzSdkDesktopCapturerSource[]>
status	Query\<JazzSdkDesktopCapturerStatus>

---

JazzSdkDesktopCapturerSource

Ƭ JazzSdkDesktopCapturerSource: Readonly\<{ displayId: string ; id: string ; image?: string ; name: string ; type: JazzSdkDesktopCapturerSourceType }>

---

JazzSdkDesktopCapturerStatus

Ƭ JazzSdkDesktopCapturerStatus: "started" | "finished"

---

JazzSdkDesktopPicker

Ƭ JazzSdkDesktopPicker: Object

Декларация типа

Name	Type
onSourceChoose	(streamId?: string, streamType?: string, screenShareAudio?: boolean) => void

---

JazzSdkMediaAccessStatus

Ƭ JazzSdkMediaAccessStatus: "not-determined" | "granted" | "denied" | "restricted" | "unknown"

---

JazzSdkMediaAccessType

Ƭ JazzSdkMediaAccessType: "microphone" | "camera" | "screen"

---

JazzSdkSystemSettingsKey

Ƭ JazzSdkSystemSettingsKey: "microphone-security" | "camera-security" | "screen-share-security"

Методы

desktopCapturerPlugin

▸ desktopCapturerPlugin(): JazzSdkPlugin

Возвращает

JazzSdkPlugin

---

getDesktopCapturer

▸ getDesktopCapturer(sdk): JazzSdkDesktopCapturerService

Параметры

Name

Type

sdk

Readonly\<{ auth: Readonly\<{ authStatus: Readonly\<{}> ; event$: Observable\<AuthEvents> ; isAuthorised: Readonly\<{}> ; loginBySdkToken: (sdkToken: string) => Promise\<boolean> ; logout: () => Promise\<void> ; setAuthToken: (authToken: string) => Promise\<boolean> ; userInfo: Readonly\<{}> }> ; conferences: Readonly\<{ close: (params: { conferenceId: string ; password: string }) => Promise\<void> ; createConference: (params: Readonly\<{ isGuestEnabled?: boolean ; isLobbyEnabled?: boolean ; title: string }>) => Promise\<Readonly\<{ id: string ; password: string ; roomTitle: string ; roomType: StringEnum\<"MEETING"> ; url: string }>> ; getDetails: (params: Readonly\<{ conferenceId: string ; password: string }>) => Promise\<Readonly\<{ roomRestrictions?: Readonly\<{ asrAllowed?: boolean ; chatAllowed?: boolean ; denoiserAllowed?: boolean ; editOwnNameAllowed?: boolean ; editTitleAllowed?: boolean ; guestAllowed?: boolean ; inviteAllowed?: boolean ; lobbyAllowed?: boolean ; maxConferenceCapacity?: number ; maxConferenceDurationSec?: number ; maxConferenceViewersCapacity?: number ; maxPremiumConferences?: number ; maxUsersForInfiniteConference?: number ; recordScreenAllowed?: boolean ; sipAllowed?: boolean ; watermarkAllowed?: boolean ; webinarAllowed?: boolean }> ; roomTitle?: string ; roomType: StringEnum\<"MEETING"> ; userRole: JazzRoomParticipantRole }>> ; join: (params: { conferenceId: string ; password: string }) => Readonly\<{ client: Readonly\<{ container: Container; serverUrl: string; auth: Readonly\<{ event$: Observable\<AuthEvents>; authStatus: Readonly\<{ get: () => AuthStatus; value$: Observable\<AuthStatus>; }>; ... 4 more ...; logout: () => Promise\<...>; }>; ... 4 more ...; destroy: () => void; }> ; connectionStatus: Readonly\<{}> ; container: Container ; displayStream: Readonly\<{}> ; dominantParticipantId: Readonly\<{}> ; error: Readonly\<{}> ; event$: Observable\<JazzRoomEvent> ; getAudioStream: (participantId: string) => undefined | MediaStream ; getParticipantSource: (participantId: string, mediaType: MediaType) => undefined | Readonly\<{ isMuted: boolean ; stream: MediaStream }> ; getVideoStream: (participantId: string, request: { source: JazzRoomVideoSource }) => undefined | MediaStream ; getVideoStreamSourceName: (participantId: string, source: JazzRoomVideoSource) => undefined | string ; leave: (options?: { endConference: boolean }) => Promise\<void> ; localParticipant: Readonly\<{}> ; localRaisedHand: Readonly\<{}> ; moderator: { grantPermission: (participantId: string, permission: "canEditOwnName" | "canEditRoomPolicy" | "canEditRoomTitle" | "canFinishCall" | "canGrantPermission" | "canInvite" | "canKickUser" | "canMuteUser" | "canRequestPermission" | "canSendMessage" | "canShareAudio" | "canShareCamera" | "canShareMedia" | "canViewModerators" | "canViewAsr" | "canManageAsr" | "canManageWatermark" | "canManageLobby" | "canManageDenoiser" | "canRecordScreen" | "canStartServerVideoRecord" | "canStartPoll" | "canSendReaction" | "canManagePoll" | "canManageSessionGroups" | "canLeaveSessionGroups", allowed: boolean) => void ; grantedPermissions: Readonly\<{}> ; kickUsers: (participantIds: string | readonly string[]) => void ; kickUsersAll: () => void ; muteUsers: (participantIds: string | readonly string[], type: RoomMuteMediaType) => void ; muteUsersAll: (type: RoomMuteMediaType) => void ; permissionRequestResolutions: Readonly\<{}> ; permissionRequests: Readonly\<{}> ; removeGrantedPermission: (permission: "canEditOwnName" | "canEditRoomPolicy" | "canEditRoomTitle" | "canFinishCall" | "canGrantPermission" | "canInvite" | "canKickUser" | "canMuteUser" | "canRequestPermission" | "canSendMessage" | "canShareAudio" | "canShareCamera" | "canShareMedia" | "canViewModerators" | "canViewAsr" | "canManageAsr" | "canManageWatermark" | "canManageLobby" | "canManageDenoiser" | "canRecordScreen" | "canStartServerVideoRecord" | "canStartPoll" | "canSendReaction" | "canManagePoll" | "canManageSessionGroups" | "canLeaveSessionGroups") => void ; rolePermissions: Readonly\<{}> ; setRolePermissions: (props: { permissions: Partial\<Readonly\<Record\<"canEditOwnName" | "canEditRoomPolicy" | "canEditRoomTitle" | "canFinishCall" | "canGrantPermission" | "canInvite" | "canKickUser" | "canMuteUser" | "canRequestPermission" | "canSendMessage" | "canShareAudio" | "canShareCamera" | "canShareMedia" | "canViewModerators" | "canViewAsr" | "canManageAsr" | "canManageWatermark" | "canManageLobby" | "canManageDenoiser" | "canRecordScreen" | "canStartServerVideoRecord" | "canStartPoll" | "canSendReaction" | "canManagePoll" | "canManageSessionGroups" | "canLeaveSessionGroups", boolean>>> ; role: JazzRoomParticipantRole }) => Promise\<void> ; setSettings: (settingsUpdate: Partial\<JazzRoomSettings>) => Promise\<void> } ; muteAudioInput: (isMuted: boolean) => Promise\<void> ; muteDisplayVideoInput: (isMuted: boolean) => Promise\<void> ; muteVideoInput: (isMuted: boolean) => Promise\<void> ; params: Readonly\<{ conferenceId: Readonly\<{}> ; conferencePassword: Readonly\<{}> ; domainUrl: Readonly\<{}> ; nodeToken: Readonly\<{}> ; nodeUrl: Readonly\<{}> ; roomId: Readonly\<{}> ; roomPassword: Readonly\<{}> ; roomType: Readonly\<{}> ; sessionSecret: Readonly\<{}> }> ; participants: Readonly\<{}> ; ready: (status?: "connected" | "disconnecting" | "disconnected") => Promise\<void> ; remoteParticipants: Readonly\<{}> ; remoteRaisedHands: Readonly\<{}> ; requestPermission: (permission: "canEditOwnName" | "canEditRoomPolicy" | "canEditRoomTitle" | "canFinishCall" | "canGrantPermission" | "canInvite" | "canKickUser" | "canMuteUser" | "canRequestPermission" | "canSendMessage" | "canShareAudio" | "canShareCamera" | "canShareMedia" | "canViewModerators" | "canViewAsr" | "canManageAsr" | "canManageWatermark" | "canManageLobby" | "canManageDenoiser" | "canRecordScreen" | "canStartServerVideoRecord" | "canStartPoll" | "canSendReaction" | "canManagePoll" | "canManageSessionGroups" | "canLeaveSessionGroups") => void ; sendReaction: (reaction: ReactionType) => void ; setDisplayVideoInput: (stream: undefined | MediaStream) => void ; setLocalRaiseHand: (isRaised: boolean) => void ; setUserAudioInput: (stream: undefined | MediaStream) => Promise\<void> ; setUserVideoInput: (stream: undefined | MediaStream) => Promise\<void> ; settings: JazzRoomSettingsQueries ; sources: Readonly\<{}> ; status: Readonly\<{}> ; userAudioStream: Readonly\<{}> ; userPermissionRequests: Readonly\<{}> ; userPermissions: Readonly\<{}> ; userVideoStream: Readonly\<{}> }> ; update: (params: { conferenceId: string ; password: string ; roomSettings: Readonly\<Partial\<Pick\<Readonly\<{ guestEnabled?: boolean ; isNext?: boolean ; jsonChatEnabled?: boolean ; lobbyEnabled?: boolean ; room3dEnabled?: boolean ; serverVideoRecordAutoStartEnabled?: boolean ; sipEnabled?: boolean ; summarizationEnabled?: boolean ; title?: string ; watermarkEnabled?: boolean }>, "title" | "watermarkEnabled" | "lobbyEnabled" | "sipEnabled" | "serverVideoRecordAutoStartEnabled" | "room3dEnabled" | "summarizationEnabled">>> }) => Promise\<void> }> ; container: Container ; destroy: () => void ; event$: Observable\<JazzClientEvent> ; isNetworkOnline: Readonly\<{}> ; sdk: Readonly\<{ container: Container ; event$: Observable\<JazzSdkEvent> } & {}> ; serverUrl: string }> | Readonly\<{ client: Readonly\<{ auth: Readonly\<{ authStatus: Readonly\<{}> ; event$: Observable\<AuthEvents> ; isAuthorised: Readonly\<{}> ; loginBySdkToken: (sdkToken: string) => Promise\<boolean> ; logout: () => Promise\<void> ; setAuthToken: (authToken: string) => Promise\<boolean> ; userInfo: Readonly\<{}> }> ; conferences: Readonly\<{ close: (params: { conferenceId: string ; password: string }) => Promise\<void> ; createConference: (params: Readonly\<{ isGuestEnabled?: boolean ; isLobbyEnabled?: boolean ; title: string }>) => Promise\<Readonly\<{ id: string ; password: string ; roomTitle: string ; roomType: StringEnum\<"MEETING"> ; url: string }>> ; getDetails: (params: Readonly\<{ conferenceId: string ; password: string }>) => Promise\<Readonly\<{ roomRestrictions?: Readonly\<{ asrAllowed?: boolean ; chatAllowed?: boolean ; denoiserAllowed?: boolean ; editOwnNameAllowed?: boolean ; editTitleAllowed?: boolean ; guestAllowed?: boolean ; inviteAllowed?: boolean ; lobbyAllowed?: boolean ; maxConferenceCapacity?: number ; maxConferenceDurationSec?: number ; maxConferenceViewersCapacity?: number ; maxPremiumConferences?: number ; maxUsersForInfiniteConference?: number ; recordScreenAllowed?: boolean ; sipAllowed?: boolean ; watermarkAllowed?: boolean ; webinarAllowed?: boolean }> ; roomTitle?: string ; roomType: StringEnum\<"MEETING"> ; userRole: JazzRoomParticipantRole }>> ; join: (params: { conferenceId: string ; password: string }) => Readonly\<{ container: Container; event$: Observable\<JazzRoomEvent>; status: Readonly\<{ get: () => JazzRoomStatus; value$: Observable\<JazzRoomStatus>; }>; ... 32 more ...; client: Readonly\<...>; }> ; update: (params: { conferenceId: string ; password: string ; roomSettings: Readonly\<Partial\<Pick\<Readonly\<{ guestEnabled?: boolean ; isNext?: boolean ; jsonChatEnabled?: boolean ; lobbyEnabled?: boolean ; room3dEnabled?: boolean ; serverVideoRecordAutoStartEnabled?: boolean ; sipEnabled?: boolean ; summarizationEnabled?: boolean ; title?: string ; watermarkEnabled?: boolean }>, "title" | "watermarkEnabled" | "lobbyEnabled" | "sipEnabled" | "serverVideoRecordAutoStartEnabled" | "room3dEnabled" | "summarizationEnabled">>> }) => Promise\<void> }> ; container: Container ; destroy: () => void ; event$: Observable\<JazzClientEvent> ; isNetworkOnline: Readonly\<{}> ; sdk: Readonly\<{ container: Container ; event$: Observable\<JazzSdkEvent> } & {}> ; serverUrl: string }> ; connectionStatus: Readonly\<{}> ; container: Container ; displayStream: Readonly\<{}> ; dominantParticipantId: Readonly\<{}> ; error: Readonly\<{}> ; event$: Observable\<JazzRoomEvent> ; getAudioStream: (participantId: string) => undefined | MediaStream ; getParticipantSource: (participantId: string, mediaType: MediaType) => undefined | Readonly\<{ isMuted: boolean ; stream: MediaStream }> ; getVideoStream: (participantId: string, request: { source: JazzRoomVideoSource }) => undefined | MediaStream ; getVideoStreamSourceName: (participantId: string, source: JazzRoomVideoSource) => undefined | string ; leave: (options?: { endConference: boolean }) => Promise\<void> ; localParticipant: Readonly\<{}> ; localRaisedHand: Readonly\<{}> ; moderator: { grantPermission: (participantId: string, permission: "canEditOwnName" | "canEditRoomPolicy" | "canEditRoomTitle" | "canFinishCall" | "canGrantPermission" | "canInvite" | "canKickUser" | "canMuteUser" | "canRequestPermission" | "canSendMessage" | "canShareAudio" | "canShareCamera" | "canShareMedia" | "canViewModerators" | "canViewAsr" | "canManageAsr" | "canManageWatermark" | "canManageLobby" | "canManageDenoiser" | "canRecordScreen" | "canStartServerVideoRecord" | "canStartPoll" | "canSendReaction" | "canManagePoll" | "canManageSessionGroups" | "canLeaveSessionGroups", allowed: boolean) => void ; grantedPermissions: Readonly\<{}> ; kickUsers: (participantIds: string | readonly string[]) => void ; kickUsersAll: () => void ; muteUsers: (participantIds: string | readonly string[], type: RoomMuteMediaType) => void ; muteUsersAll: (type: RoomMuteMediaType) => void ; permissionRequestResolutions: Readonly\<{}> ; permissionRequests: Readonly\<{}> ; removeGrantedPermission: (permission: "canEditOwnName" | "canEditRoomPolicy" | "canEditRoomTitle" | "canFinishCall" | "canGrantPermission" | "canInvite" | "canKickUser" | "canMuteUser" | "canRequestPermission" | "canSendMessage" | "canShareAudio" | "canShareCamera" | "canShareMedia" | "canViewModerators" | "canViewAsr" | "canManageAsr" | "canManageWatermark" | "canManageLobby" | "canManageDenoiser" | "canRecordScreen" | "canStartServerVideoRecord" | "canStartPoll" | "canSendReaction" | "canManagePoll" | "canManageSessionGroups" | "canLeaveSessionGroups") => void ; rolePermissions: Readonly\<{}> ; setRolePermissions: (props: { permissions: Partial\<Readonly\<Record\<"canEditOwnName" | "canEditRoomPolicy" | "canEditRoomTitle" | "canFinishCall" | "canGrantPermission" | "canInvite" | "canKickUser" | "canMuteUser" | "canRequestPermission" | "canSendMessage" | "canShareAudio" | "canShareCamera" | "canShareMedia" | "canViewModerators" | "canViewAsr" | "canManageAsr" | "canManageWatermark" | "canManageLobby" | "canManageDenoiser" | "canRecordScreen" | "canStartServerVideoRecord" | "canStartPoll" | "canSendReaction" | "canManagePoll" | "canManageSessionGroups" | "canLeaveSessionGroups", boolean>>> ; role: JazzRoomParticipantRole }) => Promise\<void> ; setSettings: (settingsUpdate: Partial\<JazzRoomSettings>) => Promise\<void> } ; muteAudioInput: (isMuted: boolean) => Promise\<void> ; muteDisplayVideoInput: (isMuted: boolean) => Promise\<void> ; muteVideoInput: (isMuted: boolean) => Promise\<void> ; params: Readonly\<{ conferenceId: Readonly\<{}> ; conferencePassword: Readonly\<{}> ; domainUrl: Readonly\<{}> ; nodeToken: Readonly\<{}> ; nodeUrl: Readonly\<{}> ; roomId: Readonly\<{}> ; roomPassword: Readonly\<{}> ; roomType: Readonly\<{}> ; sessionSecret: Readonly\<{}> }> ; participants: Readonly\<{}> ; ready: (status?: "connected" | "disconnecting" | "disconnected") => Promise\<void> ; remoteParticipants: Readonly\<{}> ; remoteRaisedHands: Readonly\<{}> ; requestPermission: (permission: "canEditOwnName" | "canEditRoomPolicy" | "canEditRoomTitle" | "canFinishCall" | "canGrantPermission" | "canInvite" | "canKickUser" | "canMuteUser" | "canRequestPermission" | "canSendMessage" | "canShareAudio" | "canShareCamera" | "canShareMedia" | "canViewModerators" | "canViewAsr" | "canManageAsr" | "canManageWatermark" | "canManageLobby" | "canManageDenoiser" | "canRecordScreen" | "canStartServerVideoRecord" | "canStartPoll" | "canSendReaction" | "canManagePoll" | "canManageSessionGroups" | "canLeaveSessionGroups") => void ; sendReaction: (reaction: ReactionType) => void ; setDisplayVideoInput: (stream: undefined | MediaStream) => void ; setLocalRaiseHand: (isRaised: boolean) => void ; setUserAudioInput: (stream: undefined | MediaStream) => Promise\<void> ; setUserVideoInput: (stream: undefined | MediaStream) => Promise\<void> ; settings: JazzRoomSettingsQueries ; sources: Readonly\<{}> ; status: Readonly\<{}> ; userAudioStream: Readonly\<{}> ; userPermissionRequests: Readonly\<{}> ; userPermissions: Readonly\<{}> ; userVideoStream: Readonly\<{}> }> | Readonly\<{ container: Container ; event$: Observable\<JazzSdkEvent> } & {}>

Возвращает

JazzSdkDesktopCapturerService