RoomFeaturesParameters
in package
Table of Contents
Properties
- $adminOnlyWebcams : bool
- $allowPolls : bool
- $allowRaiseHand : bool
- $allowRTMP : bool
- $allowScreenShare : bool
- $allowViewOtherParticipants : bool
- $allowViewOtherWebcams : bool
- $allowVirtualBg : bool
- $allowWebcams : bool
- $autoGenUserId : bool
- $breakoutRoomFeatures : BreakoutRoomFeaturesParameters
- $chatFeatures : ChatFeaturesParameters
- $displayExternalLinkFeatures : DisplayExternalLinkFeaturesParameters
- $enableAnalytics : bool
- $endToEndEncryptionFeatures : EndToEndEncryptionFeaturesParameters
- $externalMediaPlayerFeatures : ExternalMediaPlayerFeaturesParameters
- $ingressFeatures : IngressFeaturesParameters
- $muteOnStart : bool
- $recordingFeatures : RecordingFeaturesParameters
- $roomDuration : int
- $sharedNotePadFeatures : SharedNotePadFeaturesParameters
- $speechToTextTranslationFeatures : SpeechToTextTranslationFeaturesParameters
- $waitingRoomFeatures : WaitingRoomFeaturesParameters
- $whiteboardFeatures : WhiteboardFeaturesParameters
Methods
- __construct() : mixed
- buildBody() : array<string|int, mixed>
- getBreakoutRoomFeatures() : BreakoutRoomFeaturesParameters
- getChatFeatures() : ChatFeaturesParameters
- getDisplayExternalLinkFeatures() : DisplayExternalLinkFeaturesParameters
- getEndToEndEncryptionFeatures() : EndToEndEncryptionFeaturesParameters
- getExternalMediaPlayerFeatures() : ExternalMediaPlayerFeaturesParameters
- getIngressFeatures() : IngressFeaturesParameters
- getRecordingFeatures() : RecordingFeaturesParameters
- getRoomDuration() : int
- getSharedNotePadFeatures() : SharedNotePadFeaturesParameters
- getSpeechToTextTranslationFeatures() : SpeechToTextTranslationFeaturesParameters
- getWaitingRoomFeatures() : WaitingRoomFeaturesParameters
- getWhiteboardFeatures() : WhiteboardFeaturesParameters
- isAdminOnlyWebcams() : bool
- isAllowPolls() : bool
- isAllowRaiseHand() : bool
- isAllowRTMP() : bool
- isAllowScreenShare() : bool
- isAllowViewOtherParticipants() : bool
- isAllowViewOtherWebcams() : bool
- isAllowVirtualBg() : bool
- isAllowWebcams() : bool
- isAutoGenUserId() : bool
- isEnableAnalytics() : bool
- isMuteOnStart() : bool
- setAdminOnlyWebcams() : mixed
- setAllowPolls() : void
- setAllowRaiseHand() : void
- setAllowRTMP() : mixed
- setAllowScreenShare() : mixed
- setAllowViewOtherParticipants() : void
- setAllowViewOtherWebcams() : void
- setAllowVirtualBg() : void
- setAllowWebcams() : mixed
- setAutoGenUserId() : void
- setBreakoutRoomFeatures() : void
- setChatFeatures() : mixed
- setDisplayExternalLinkFeatures() : void
- setEnableAnalytics() : void
- setEndToEndEncryptionFeatures() : void
- setExternalMediaPlayerFeatures() : void
- setIngressFeatures() : void
- setMuteOnStart() : void
- setRecordingFeatures() : void
- setRoomDuration() : void
- setSharedNotePadFeatures() : void
- setSpeechToTextTranslationFeatures() : void
- setWaitingRoomFeatures() : void
- setWhiteboardFeatures() : void
Properties
$adminOnlyWebcams
protected
bool
$adminOnlyWebcams
= false
$allowPolls
protected
bool
$allowPolls
= true
$allowRaiseHand
protected
bool
$allowRaiseHand
= true
$allowRTMP
protected
bool
$allowRTMP
= true
$allowScreenShare
protected
bool
$allowScreenShare
= true
$allowViewOtherParticipants
protected
bool
$allowViewOtherParticipants
= true
$allowViewOtherWebcams
protected
bool
$allowViewOtherWebcams
= true
$allowVirtualBg
protected
bool
$allowVirtualBg
= true
$allowWebcams
protected
bool
$allowWebcams
= true
$autoGenUserId
protected
bool
$autoGenUserId
= false
$breakoutRoomFeatures
protected
BreakoutRoomFeaturesParameters
$breakoutRoomFeatures
$chatFeatures
protected
ChatFeaturesParameters
$chatFeatures
$displayExternalLinkFeatures
protected
DisplayExternalLinkFeaturesParameters
$displayExternalLinkFeatures
$enableAnalytics
protected
bool
$enableAnalytics
= false
$endToEndEncryptionFeatures
protected
EndToEndEncryptionFeaturesParameters
$endToEndEncryptionFeatures
$externalMediaPlayerFeatures
protected
ExternalMediaPlayerFeaturesParameters
$externalMediaPlayerFeatures
$ingressFeatures
protected
IngressFeaturesParameters
$ingressFeatures
$muteOnStart
protected
bool
$muteOnStart
= false
$recordingFeatures
protected
RecordingFeaturesParameters
$recordingFeatures
$roomDuration
protected
int
$roomDuration
= 0
$sharedNotePadFeatures
protected
SharedNotePadFeaturesParameters
$sharedNotePadFeatures
$speechToTextTranslationFeatures
protected
SpeechToTextTranslationFeaturesParameters
$speechToTextTranslationFeatures
$waitingRoomFeatures
protected
WaitingRoomFeaturesParameters
$waitingRoomFeatures
$whiteboardFeatures
protected
WhiteboardFeaturesParameters
$whiteboardFeatures
Methods
__construct()
public
__construct() : mixed
buildBody()
public
buildBody() : array<string|int, mixed>
Return values
array<string|int, mixed>getBreakoutRoomFeatures()
public
getBreakoutRoomFeatures() : BreakoutRoomFeaturesParameters
Return values
BreakoutRoomFeaturesParametersgetChatFeatures()
public
getChatFeatures() : ChatFeaturesParameters
Return values
ChatFeaturesParametersgetDisplayExternalLinkFeatures()
public
getDisplayExternalLinkFeatures() : DisplayExternalLinkFeaturesParameters
Return values
DisplayExternalLinkFeaturesParametersgetEndToEndEncryptionFeatures()
public
getEndToEndEncryptionFeatures() : EndToEndEncryptionFeaturesParameters
Return values
EndToEndEncryptionFeaturesParametersgetExternalMediaPlayerFeatures()
public
getExternalMediaPlayerFeatures() : ExternalMediaPlayerFeaturesParameters
Return values
ExternalMediaPlayerFeaturesParametersgetIngressFeatures()
public
getIngressFeatures() : IngressFeaturesParameters
Return values
IngressFeaturesParametersgetRecordingFeatures()
public
getRecordingFeatures() : RecordingFeaturesParameters
Return values
RecordingFeaturesParametersgetRoomDuration()
public
getRoomDuration() : int
Return values
intgetSharedNotePadFeatures()
public
getSharedNotePadFeatures() : SharedNotePadFeaturesParameters
Return values
SharedNotePadFeaturesParametersgetSpeechToTextTranslationFeatures()
public
getSpeechToTextTranslationFeatures() : SpeechToTextTranslationFeaturesParameters
Return values
SpeechToTextTranslationFeaturesParametersgetWaitingRoomFeatures()
public
getWaitingRoomFeatures() : WaitingRoomFeaturesParameters
Return values
WaitingRoomFeaturesParametersgetWhiteboardFeatures()
public
getWhiteboardFeatures() : WhiteboardFeaturesParameters
Return values
WhiteboardFeaturesParametersisAdminOnlyWebcams()
public
isAdminOnlyWebcams() : bool
Return values
boolisAllowPolls()
public
isAllowPolls() : bool
Return values
boolisAllowRaiseHand()
public
isAllowRaiseHand() : bool
Return values
boolisAllowRTMP()
public
isAllowRTMP() : bool
Return values
boolisAllowScreenShare()
public
isAllowScreenShare() : bool
Return values
boolisAllowViewOtherParticipants()
public
isAllowViewOtherParticipants() : bool
Return values
boolisAllowViewOtherWebcams()
public
isAllowViewOtherWebcams() : bool
Return values
boolisAllowVirtualBg()
public
isAllowVirtualBg() : bool
Return values
boolisAllowWebcams()
public
isAllowWebcams() : bool
Return values
boolisAutoGenUserId()
public
isAutoGenUserId() : bool
Return values
boolisEnableAnalytics()
public
isEnableAnalytics() : bool
Return values
boolisMuteOnStart()
public
isMuteOnStart() : bool
Return values
boolsetAdminOnlyWebcams()
public
setAdminOnlyWebcams(bool $adminOnlyWebcams) : mixed
Parameters
- $adminOnlyWebcams : bool
setAllowPolls()
public
setAllowPolls(bool $allowPolls) : void
Parameters
- $allowPolls : bool
setAllowRaiseHand()
public
setAllowRaiseHand(bool $allowRaiseHand) : void
Parameters
- $allowRaiseHand : bool
setAllowRTMP()
public
setAllowRTMP(bool $allowRTMP) : mixed
Parameters
- $allowRTMP : bool
setAllowScreenShare()
public
setAllowScreenShare(bool $allowScreenShare) : mixed
Parameters
- $allowScreenShare : bool
setAllowViewOtherParticipants()
public
setAllowViewOtherParticipants(bool $allowViewOtherParticipants) : void
Parameters
- $allowViewOtherParticipants : bool
setAllowViewOtherWebcams()
public
setAllowViewOtherWebcams(bool $allowViewOtherWebcams) : void
Parameters
- $allowViewOtherWebcams : bool
setAllowVirtualBg()
public
setAllowVirtualBg(bool $allowVirtualBg) : void
Parameters
- $allowVirtualBg : bool
setAllowWebcams()
public
setAllowWebcams(bool $allowWebcams) : mixed
Parameters
- $allowWebcams : bool
setAutoGenUserId()
public
setAutoGenUserId(bool $autoGenUserId) : void
Parameters
- $autoGenUserId : bool
setBreakoutRoomFeatures()
public
setBreakoutRoomFeatures(BreakoutRoomFeaturesParameters $breakoutRoomFeatures) : void
Parameters
- $breakoutRoomFeatures : BreakoutRoomFeaturesParameters
setChatFeatures()
public
setChatFeatures(ChatFeaturesParameters $chatFeatures) : mixed
Parameters
- $chatFeatures : ChatFeaturesParameters
setDisplayExternalLinkFeatures()
public
setDisplayExternalLinkFeatures(DisplayExternalLinkFeaturesParameters $displayExternalLinkFeatures) : void
Parameters
- $displayExternalLinkFeatures : DisplayExternalLinkFeaturesParameters
setEnableAnalytics()
public
setEnableAnalytics(bool $enableAnalytics) : void
Parameters
- $enableAnalytics : bool
setEndToEndEncryptionFeatures()
public
setEndToEndEncryptionFeatures(EndToEndEncryptionFeaturesParameters $endToEndEncryptionFeatures) : void
Parameters
- $endToEndEncryptionFeatures : EndToEndEncryptionFeaturesParameters
setExternalMediaPlayerFeatures()
public
setExternalMediaPlayerFeatures(ExternalMediaPlayerFeaturesParameters $externalMediaPlayerFeatures) : void
Parameters
- $externalMediaPlayerFeatures : ExternalMediaPlayerFeaturesParameters
setIngressFeatures()
public
setIngressFeatures(IngressFeaturesParameters $ingressFeatures) : void
Parameters
- $ingressFeatures : IngressFeaturesParameters
setMuteOnStart()
public
setMuteOnStart(bool $muteOnStart) : void
Parameters
- $muteOnStart : bool
setRecordingFeatures()
public
setRecordingFeatures(RecordingFeaturesParameters $recordingFeatures) : void
Parameters
- $recordingFeatures : RecordingFeaturesParameters
setRoomDuration()
public
setRoomDuration(int $roomDuration) : void
Parameters
- $roomDuration : int
setSharedNotePadFeatures()
public
setSharedNotePadFeatures(SharedNotePadFeaturesParameters $sharedNotePadFeatures) : void
Parameters
- $sharedNotePadFeatures : SharedNotePadFeaturesParameters
setSpeechToTextTranslationFeatures()
public
setSpeechToTextTranslationFeatures(SpeechToTextTranslationFeaturesParameters $speechToTextTranslationFeatures) : void
Parameters
- $speechToTextTranslationFeatures : SpeechToTextTranslationFeaturesParameters
setWaitingRoomFeatures()
public
setWaitingRoomFeatures(WaitingRoomFeaturesParameters $waitingRoomFeatures) : void
Parameters
- $waitingRoomFeatures : WaitingRoomFeaturesParameters
setWhiteboardFeatures()
public
setWhiteboardFeatures(WhiteboardFeaturesParameters $whiteboardFeatures) : void
Parameters
- $whiteboardFeatures : WhiteboardFeaturesParameters