VoiceChatService
This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
| Memory category | Instances |
|---|
Member index 40
Removed member index 24
History 148
- 633 Add
- 633 Add
- 632 Add
- 631 Add joinVoice
- 621 Add
- 621 Add
- 615 Add
- 613 Change Tags of UseAudioApi from [NotBrowsable] to []
- 607 Add
- 607 Add
- 607 Add
- 605 Add
- 605 Add
- 604 Add UseAudioApi
- 603 Remove UseAudioApi
- 604 Add UseAudioApi
- 600 Add
- 598 Add
- 597 Change Parameters of from (handshakeOffer: string, subscriptionInfo: string, isNewConnection: bool, sessionId: string) to (handshakeOffer: string, newSubscriptionStates: string, isNewConnection: bool, sessionId: string, eventTag: int64)
- 597 Change Parameters of from (subscriptionInfo: string, sessionId: string) to (sessionId: string, eventTag: int64)
- 597 Change Parameters of from (eventTag: int, handshakeAnswer: string, userToMute: string, sessionId: string) to (eventTag: int64, handshakeAnswer: string, usersToMute: string, sessionId: string)
- 597 Add
- 597 Add
- 595 Change Parameters of from (voiceControlPath: VoiceControlPath, serializedFailure: string) to (voiceControlPath: VoiceControlPath, serializedFailure: string, sessionId: string)
- 595 Change Parameters of from (handshakeOffer: string, subscriptionInfo: string, isNewConnection: bool) to (handshakeOffer: string, subscriptionInfo: string, isNewConnection: bool, sessionId: string)
- 595 Change Parameters of from (subscriptionInfo: string) to (subscriptionInfo: string, sessionId: string)
- 595 Change Parameters of from (eventTag: int, handshakeAnswer: string, userToMute: string) to (eventTag: int, handshakeAnswer: string, userToMute: string, sessionId: string)
- 595 Change Parameters of from (voiceControlPath: VoiceControlPath, serializedIceCandidates: string) to (voiceControlPath: VoiceControlPath, serializedIceCandidates: string, isLast: bool, sessionId: string)
- 595 Change Parameters of from (handshakeOffer: string, muteState: MuteState) to (handshakeOffer: string, muteState: MuteState, sessionId: string)
- 595 Change Parameters of from () to (sessionId: string)
- 595 Change Parameters of from (handshakeAnswer: string) to (handshakeAnswer: string, sessionId: string)
- 594 Add
- 594 Add
- 594 Add
- 593 Add
- 593 Add
- 593 Add
- 593 Add
- 593 Add
- 593 Add
- 590 Change Tags of from [Hidden, NotScriptable] to [Hidden]
- 589 Add
- 587 Change CanSave of from true to false
- 587 Change Tags of from [] to [Hidden]
- 587 Change CanLoad of from true to false
- 583 Change Security of from RobloxScriptSecurity to RobloxSecurity
- 582 Add
- 582 Add
- 581 Add
- 581 Add
- 580 Add
- 580 Add
- 576 Add
- 566 Add
- 566 Add
- 553 Change Default of from to false
- 553 Change Default of from to false
- 553 Change Default of EnableDefaultVoice from to true
- 524 Change Tags of EnableDefaultVoice from [NotBrowsable] to []
- 521 Change Tags of from [ReadOnly, NotReplicated] to [Hidden]
- 521 Change CanSave of from true to false
- 521 Change Tags of from [ReadOnly, NotReplicated] to [Hidden]
- 521 Change CanSave of from true to false
- 520 Add
- 520 Add
- 519 Remove GenerateDefaultChannel
- 519 Add EnableDefaultVoice
- 506 Change Tags of VoiceChatService from [NotCreatable, Service, Deprecated] to [NotCreatable, Service]
- 505 Add GenerateDefaultChannel
- 504 Change Tags of VoiceChatService from [NotCreatable, Service] to [NotCreatable, Service, Deprecated]
- 502 Change Tags of VoiceChatService from [Service] to [NotCreatable, Service]
- 499 Remove StateChanged
- 499 Remove PlayerMicActivitySignalChange
- 499 Remove ParticipantsStateChanged
- 499 Remove SubscribePauseAll
- 499 Remove SubscribePause
- 499 Remove SetSpeakerDevice
- 499 Remove SetMicDevice
- 499 Remove PublishPause
- 499 Remove Leave
- 499 Remove JoinByGroupIdToken
- 499 Remove JoinByGroupId
- 499 Remove IsSubscribePaused
- 499 Remove IsPublishPaused
- 499 Remove IsContextVoiceEnabled
- 499 Remove GetVoiceChatAvailable
- 499 Remove GetVoiceChatApiVersion
- 499 Remove GetSpeakerDevices
- 499 Remove GetParticipants
- 499 Remove GetMicDevices
- 499 Remove GetGroupId
- 499 Remove GetAudioProcessingSettings
- 499 Remove GetAndClearCallFailureMessage
- 499 Remove
- 499 Change Tags of VoiceChatService from [NotCreatable, Service] to [Service]
- 498 Change Security of StateChanged from None to RobloxScriptSecurity
- 498 Change Security of PlayerMicActivitySignalChange from None to RobloxScriptSecurity
- 498 Change Security of ParticipantsStateChanged from None to RobloxScriptSecurity
- 498 Change Security of GetAndClearCallFailureMessage from None to RobloxScriptSecurity
- 498 Change ReadSecurity of from None to RobloxScriptSecurity
- 498 Change WriteSecurity of from None to RobloxScriptSecurity
- 497 Change Tags of StateChanged from [] to [Deprecated]
- 497 Change Tags of PlayerMicActivitySignalChange from [] to [Deprecated]
- 497 Change Tags of ParticipantsStateChanged from [] to [Deprecated]
- 497 Change Tags of SubscribePauseAll from [] to [Deprecated]
- 497 Change Tags of SubscribePause from [] to [Deprecated]
- 497 Change Tags of SetSpeakerDevice from [] to [Deprecated]
- 497 Change Tags of SetMicDevice from [] to [Deprecated]
- 497 Change Tags of PublishPause from [] to [Deprecated]
- 497 Change Tags of Leave from [] to [Deprecated]
- 497 Change Tags of JoinByGroupIdToken from [] to [Deprecated]
- 497 Change Tags of JoinByGroupId from [] to [Deprecated]
- 497 Add IsVoiceEnabledForUserIdAsync
- 497 Change Tags of IsSubscribePaused from [] to [Deprecated]
- 497 Change Tags of IsPublishPaused from [] to [Deprecated]
- 497 Change Tags of GetVoiceChatAvailable from [] to [Deprecated]
- 497 Change Tags of GetVoiceChatApiVersion from [] to [Deprecated]
- 497 Change Tags of GetSpeakerDevices from [] to [Deprecated]
- 497 Change Tags of GetParticipants from [] to [Deprecated]
- 497 Change Tags of GetMicDevices from [] to [Deprecated]
- 497 Change Tags of GetAudioProcessingSettings from [] to [Deprecated]
- 497 Change Tags of GetAndClearCallFailureMessage from [] to [Deprecated]
- 497 Change CanSave of from true to false
- 497 Change Tags of from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated, Deprecated]
- 494 Add SubscribePauseAll
- 494 Add IsContextVoiceEnabled
- 490 Add StateChanged
- 490 Add PlayerMicActivitySignalChange
- 490 Add ParticipantsStateChanged
- 490 Add SubscribePause
- 490 Add SetSpeakerDevice
- 490 Add SetMicDevice
- 490 Add PublishPause
- 490 Add Leave
- 490 Add JoinByGroupIdToken
- 490 Add JoinByGroupId
- 490 Add IsSubscribePaused
- 490 Add IsPublishPaused
- 490 Add GetVoiceChatAvailable
- 490 Add GetVoiceChatApiVersion
- 490 Add GetSpeakerDevices
- 490 Add GetParticipants
- 490 Add GetMicDevices
- 490 Add GetGroupId
- 490 Add GetAudioProcessingSettings
- 490 Add GetAndClearCallFailureMessage
- 490 Add
- 490 Add VoiceChatService
Members 40
EnableDefaultVoice
| Type | Default | |
|---|---|---|
| bool | true | |
| Security | PluginSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Behavior |
| Loaded/Saved | true |
History 3
- 553 Change Default of EnableDefaultVoice from to true
- 524 Change Tags of EnableDefaultVoice from [NotBrowsable] to []
- 519 Add EnableDefaultVoice
IsVoiceEnabledForUserIdAsync
| Parameters (1) | ||
|---|---|---|
| userId | int64 | |
| Returns (1) | ||
| bool | ||
This function yields. It will block the calling thread until completion.
| Thread safety | Unsafe |
|---|
History 1
UseAudioApi
| Type | Default | |
|---|---|---|
| AudioApiRollout | Automatic | |
| Security | PluginSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Behavior |
| Loaded/Saved | true |
History 4
- 613 Change Tags of UseAudioApi from [NotBrowsable] to []
- 604 Add UseAudioApi
- 603 Remove UseAudioApi
- 604 Add UseAudioApi
joinVoice
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| null | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
Removed members 24
GenerateDefaultChannel
| Type | Default | |
|---|---|---|
| bool | ||
This property is not browsable. It is not visible in Studio's object browser.
| Security | PluginSecurity |
|---|---|
| Thread safety | ReadSafe |
| Category | Behavior |
| Loaded/Saved | true |
History 2
- 519 Remove GenerateDefaultChannel
- 505 Add GenerateDefaultChannel
GetAndClearCallFailureMessage
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| string | ||
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 4
- 499 Remove GetAndClearCallFailureMessage
- 498 Change Security of GetAndClearCallFailureMessage from None to RobloxScriptSecurity
- 497 Change Tags of GetAndClearCallFailureMessage from [] to [Deprecated]
- 490 Add GetAndClearCallFailureMessage
GetAudioProcessingSettings
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Tuple | ||
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
History 3
- 499 Remove GetAudioProcessingSettings
- 497 Change Tags of GetAudioProcessingSettings from [] to [Deprecated]
- 490 Add GetAudioProcessingSettings
GetGroupId
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| string | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 499 Remove GetGroupId
- 490 Add GetGroupId
GetMicDevices
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Tuple | ||
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
History 3
- 499 Remove GetMicDevices
- 497 Change Tags of GetMicDevices from [] to [Deprecated]
- 490 Add GetMicDevices
GetParticipants
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Array | ||
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
History 3
- 499 Remove GetParticipants
- 497 Change Tags of GetParticipants from [] to [Deprecated]
- 490 Add GetParticipants
GetSpeakerDevices
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Tuple | ||
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
History 3
- 499 Remove GetSpeakerDevices
- 497 Change Tags of GetSpeakerDevices from [] to [Deprecated]
- 490 Add GetSpeakerDevices
GetVoiceChatApiVersion
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| int | ||
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
History 3
- 499 Remove GetVoiceChatApiVersion
- 497 Change Tags of GetVoiceChatApiVersion from [] to [Deprecated]
- 490 Add GetVoiceChatApiVersion
GetVoiceChatAvailable
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| int | ||
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
History 3
- 499 Remove GetVoiceChatAvailable
- 497 Change Tags of GetVoiceChatAvailable from [] to [Deprecated]
- 490 Add GetVoiceChatAvailable
IsContextVoiceEnabled
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| bool | ||
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 2
- 499 Remove IsContextVoiceEnabled
- 494 Add IsContextVoiceEnabled
IsPublishPaused
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| bool | ||
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
History 3
- 499 Remove IsPublishPaused
- 497 Change Tags of IsPublishPaused from [] to [Deprecated]
- 490 Add IsPublishPaused
IsSubscribePaused
| Parameters (1) | ||
|---|---|---|
| userId | int64 | |
| Returns (1) | ||
| bool | ||
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
History 3
- 499 Remove IsSubscribePaused
- 497 Change Tags of IsSubscribePaused from [] to [Deprecated]
- 490 Add IsSubscribePaused
JoinByGroupId
| Parameters (2) | Default | |
|---|---|---|
| groupId | string | |
| isMicMuted | bool | false |
| Returns (1) | ||
| bool | ||
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
History 3
- 499 Remove JoinByGroupId
- 497 Change Tags of JoinByGroupId from [] to [Deprecated]
- 490 Add JoinByGroupId
JoinByGroupIdToken
| Parameters (2) | Default | |
|---|---|---|
| groupId | string | |
| isMicMuted | bool | false |
| Returns (1) | ||
| bool | ||
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
History 3
- 499 Remove JoinByGroupIdToken
- 497 Change Tags of JoinByGroupIdToken from [] to [Deprecated]
- 490 Add JoinByGroupIdToken
Leave
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| void | ||
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
ParticipantsStateChanged
| Parameters (3) | |
|---|---|
| participantsLeft | Array |
| participantsJoined | Array |
| updatedStates | Array |
This event is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 4
- 499 Remove ParticipantsStateChanged
- 498 Change Security of ParticipantsStateChanged from None to RobloxScriptSecurity
- 497 Change Tags of ParticipantsStateChanged from [] to [Deprecated]
- 490 Add ParticipantsStateChanged
PlayerMicActivitySignalChange
| Parameters (1) | |
|---|---|
| activityInfo | Dictionary |
This event is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 4
- 499 Remove PlayerMicActivitySignalChange
- 498 Change Security of PlayerMicActivitySignalChange from None to RobloxScriptSecurity
- 497 Change Tags of PlayerMicActivitySignalChange from [] to [Deprecated]
- 490 Add PlayerMicActivitySignalChange
PublishPause
| Parameters (1) | ||
|---|---|---|
| paused | bool | |
| Returns (1) | ||
| bool | ||
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
History 3
- 499 Remove PublishPause
- 497 Change Tags of PublishPause from [] to [Deprecated]
- 490 Add PublishPause
SetMicDevice
| Parameters (2) | ||
|---|---|---|
| micDeviceName | string | |
| micDeviceGuid | string | |
| Returns (1) | ||
| void | ||
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
History 3
- 499 Remove SetMicDevice
- 497 Change Tags of SetMicDevice from [] to [Deprecated]
- 490 Add SetMicDevice
SetSpeakerDevice
| Parameters (2) | ||
|---|---|---|
| speakerDeviceName | string | |
| speakerDeviceGuid | string | |
| Returns (1) | ||
| void | ||
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
History 3
- 499 Remove SetSpeakerDevice
- 497 Change Tags of SetSpeakerDevice from [] to [Deprecated]
- 490 Add SetSpeakerDevice
StateChanged
| Parameters (2) | |
|---|---|
| old | VoiceChatState |
| new | VoiceChatState |
This event is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Security | RobloxScriptSecurity |
|---|---|
| Thread safety | Unsafe |
History 4
- 499 Remove StateChanged
- 498 Change Security of StateChanged from None to RobloxScriptSecurity
- 497 Change Tags of StateChanged from [] to [Deprecated]
- 490 Add StateChanged
SubscribePause
| Parameters (2) | ||
|---|---|---|
| userId | int64 | |
| paused | bool | |
| Returns (1) | ||
| bool | ||
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
History 3
- 499 Remove SubscribePause
- 497 Change Tags of SubscribePause from [] to [Deprecated]
- 490 Add SubscribePause
SubscribePauseAll
| Parameters (1) | ||
|---|---|---|
| paused | bool | |
| Returns (1) | ||
| bool | ||
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
| Thread safety | Unsafe |
|---|
History 3
- 499 Remove SubscribePauseAll
- 497 Change Tags of SubscribePauseAll from [] to [Deprecated]
- 494 Add SubscribePauseAll