C_VoiceChat

namespaceavailable in: camelot

Status in wowlua

82 functions: 1 implemented, 9 recorded, 72 guessed. 51 events, 6 of them fired by the emulator on its own.

Functions

function	what it does	status
`ActivateChannel`	Makes a voice chat channel the active one. · by wowlua `(channelID: VoiceChatID)`	guessed
`ActivateChannelTranscription`	Turns on speech-to-text transcription for a voice chat channel. · by wowlua `(channelID: VoiceChatID)`	guessed
`BeginLocalCapture`	Starts capturing the microphone, for example to test it. · by wowlua `(listenToLocalUser: boolean)`	guessed
`CanAccessSettings`	Whether the player can access the voice chat settings. · by wowlua `(): boolean`	guessed
`CanPlayerUseVoiceChat`	Whether the player can use voice chat. · by wowlua `(): boolean`	guessed
`CreateChannel`	Creates a voice chat channel and returns the status of the request. · by wowlua `(channelDisplayName: string): VoiceChatStatusCode`	guessed
`DeactivateChannel`	Stops a voice chat channel from being the active one. · by wowlua `(channelID: VoiceChatID)`	guessed
`DeactivateChannelTranscription`	Turns off speech-to-text transcription for a voice chat channel. · by wowlua `(channelID: VoiceChatID)`	guessed
`EndLocalCapture`	Stops capturing the microphone started with `C_VoiceChat.BeginLocalCapture`. · by wowlua `()`	guessed
`GetActiveChannelID`	Returns the ID of the active voice chat channel. · by wowlua `(): VoiceChatID?`	guessed
`GetActiveChannelType`	Returns the type of the active voice chat channel. · by wowlua `(): ChatChannelType?`	recorded
`GetActiveVoiceProviderID`	Returns the ID of the active voice chat provider. · by wowlua `(): VoiceProviderID`	recorded
`GetAvailableInputDevices`	Returns the audio input devices voice chat can use. · by wowlua `(): VoiceAudioDevice[]?`	guessed
`GetAvailableOutputDevices`	Returns the audio output devices voice chat can use. · by wowlua `(): VoiceAudioDevice[]?`	guessed
`GetChannel`	Returns information about a voice chat channel. · by wowlua `(channelID: VoiceChatID): VoiceChatChannel?`	guessed
`GetChannelForChannelType`	Returns the voice chat channel of a channel type. · by wowlua `(channelType: ChatChannelType): VoiceChatChannel?`	guessed
`GetChannelForCommunityStream`	Returns the voice chat channel of a community stream. · by wowlua `(clubId: ClubId, streamId: ClubStreamId): VoiceChatChannel?`	guessed
`GetCommunicationMode`	Returns how the player transmits voice: push-to-talk or open mic. · by wowlua `(): CommunicationMode?`	guessed
`GetCurrentVoiceChatConnectionStatusCode`	Returns the status of the voice chat connection. · by wowlua `(): VoiceChatStatusCode?`	guessed
`GetInputVolume`	Returns the microphone volume. · by wowlua `(): number?`	guessed
`GetJoinClubVoiceChannelError`	Returns why the player cannot join a community's voice channel, or nil if they can. · by wowlua `(clubId: ClubId): VoiceChannelErrorReason?`	guessed
`GetLocalPlayerActiveChannelMemberInfo`	Returns the player's member information in the active voice chat channel. · by wowlua `(): VoiceChatMember?`	guessed
`GetLocalPlayerMemberID`	Returns the player's member ID in a voice chat channel. · by wowlua `(channelID: VoiceChatID): VoiceChatID?`	guessed
`GetMasterVolumeScale`	Returns the master volume scale of voice chat. · by wowlua `(): number`	guessed
`GetMemberGUID`	Returns the player GUID of a voice chat channel member. · by wowlua `(memberID: VoiceChatID, channelID: VoiceChatID): string`	guessed
`GetMemberID`	Returns the member ID of a player in a voice chat channel. · by wowlua `(channelID: VoiceChatID, memberGUID: string): VoiceChatID?`	guessed
`GetMemberInfo`	Returns information about a voice chat channel member. · by wowlua `(memberID: VoiceChatID, channelID: VoiceChatID): VoiceChatMember?`	guessed
`GetMemberName`	Returns the name of a voice chat channel member. · by wowlua `(memberID: VoiceChatID, channelID: VoiceChatID): string?`	guessed
`GetMemberVolume`	Returns the volume at which the player hears a voice chat member. · by wowlua `(playerLocation: PlayerLocationMixin): number?`	guessed
`GetOutputVolume`	Returns the voice chat output volume. · by wowlua `(): number?`	guessed
`GetPTTButtonPressedState`	Whether the push-to-talk key is held down. · by wowlua `(): boolean?`	guessed
`GetProcesses`	Returns the voice chat processes. · by wowlua `(): VoiceChatProcess[]?`	guessed
`GetPushToTalkBinding`	Returns the keys bound to push-to-talk. · by wowlua `(): string[]?`	recorded
`GetRemoteTtsVoices`	Returns the remote text-to-speech voices. · by wowlua `(): VoiceTtsVoiceType[]`	guessed
`GetTtsVoices`	Returns the text-to-speech voices. · by wowlua `(): VoiceTtsVoiceType[]`	implemented
`GetVADSensitivity`	Returns the voice activation sensitivity. · by wowlua `(): number?`	guessed
`IsChannelJoinPending`	Whether a request to join a voice chat channel is still pending. · by wowlua `(channelType: ChatChannelType, clubId: ClubId?, streamId: ClubStreamId?): boolean`	guessed
`IsDeafened`	Whether the player has deafened voice chat. · by wowlua `(): boolean?`	guessed
`IsEnabled`	Whether voice chat is enabled. · by wowlua `(): boolean`	recorded
`IsLoggedIn`	Whether the player is logged in to voice chat. · by wowlua `(): boolean`	recorded
`IsMemberLocalPlayer`	Whether a voice chat channel member is the player. · by wowlua `(memberID: VoiceChatID, channelID: VoiceChatID): boolean`	guessed
`IsMemberMuted`	Whether the player has muted a voice chat member. · by wowlua `(playerLocation: PlayerLocationMixin): boolean?`	guessed
`IsMemberMutedForAll`	Whether a voice chat channel member is muted for everyone. · by wowlua `(memberID: VoiceChatID, channelID: VoiceChatID): boolean?`	guessed
`IsMemberSilenced`	Whether a voice chat channel member is silenced. · by wowlua `(memberID: VoiceChatID, channelID: VoiceChatID): boolean?`	guessed
`IsMuted`	Whether the player has muted their microphone. · by wowlua `(): boolean?`	recorded
`IsParentalDisabled`	Whether parental controls disable voice chat. · by wowlua `(): boolean`	guessed
`IsParentalMuted`	Whether parental controls mute voice chat. · by wowlua `(): boolean`	guessed
`IsPlayerUsingVoice`	Whether a player is using voice chat. · by wowlua `(playerLocation: PlayerLocationMixin): boolean`	guessed
`IsSilenced`	Whether the player is silenced in voice chat. · by wowlua `(): boolean?`	guessed
`IsSpeakForMeActive`	Whether text-to-speech for the player's chat messages (Speak for Me) is active. · by wowlua `(): boolean`	recorded
`IsSpeakForMeAllowed`	Whether text-to-speech for the player's chat messages (Speak for Me) is allowed. · by wowlua `(): boolean`	recorded
`IsTranscribing`	Whether voice chat is being transcribed to text. · by wowlua `(): boolean`	guessed
`IsTranscriptionAllowed`	Whether voice chat transcription is allowed. · by wowlua `(): boolean`	recorded
`IsVoiceChatConnected`	Whether voice chat is connected. · by wowlua `(): boolean`	guessed
`LeaveChannel`	Leaves a voice chat channel. · by wowlua `(channelID: VoiceChatID)`	guessed
`Login`	Logs in to voice chat and returns the status of the request. · by wowlua `(channelType: ChatChannelType?): VoiceChatStatusCode`	guessed
`Logout`	Logs out of voice chat and returns the status of the request. · by wowlua `(): VoiceChatStatusCode`	guessed
`MarkChannelsDiscovered`	Once the UI has enumerated all channels, use this to reset the channel discovery state, it will be updated again if appropriate `()`	guessed
`RequestJoinAndActivateCommunityStreamChannel`	Joins a community stream's voice channel and makes it the active one. · by wowlua `(clubId: ClubId, streamId: ClubStreamId)`	guessed
`RequestJoinChannelByChannelType`	Requests to join the voice chat channel of a channel type. · by wowlua `(channelType: ChatChannelType, autoActivate: boolean?)`	guessed
`RestoreActiveVoiceProvider`	Changes the active voice provider to the party voice provider, or to the preferred voice provider when the party has none. `(): boolean`	guessed
`SetActiveVoiceProvider`	Changes the active voice provider without changing the preferred voice provider. `(voiceProviderID: VoiceProviderID): boolean`	guessed
`SetCommunicationMode`	Sets how the player transmits voice: push-to-talk or open mic. · by wowlua `(communicationMode: CommunicationMode)`	guessed
`SetDeafened`	Sets whether voice chat is deafened. · by wowlua `(isDeafened: boolean)`	guessed
`SetInputDevice`	Sets the audio input device for voice chat. · by wowlua `(deviceID: string)`	guessed
`SetInputVolume`	Sets the microphone volume. · by wowlua `(volume: number)`	guessed
`SetMasterVolumeScale`	Sets the master volume scale of voice chat. · by wowlua `(scale: number)`	guessed
`SetMemberMuted`	Mutes or unmutes a voice chat member for the player. · by wowlua `(playerLocation: PlayerLocationMixin, muted: boolean)`	guessed
`SetMemberVolume`	Adjusts member volume across all channels `(playerLocation: PlayerLocationMixin, volume: number)`	guessed
`SetMuted`	Mutes or unmutes the player's microphone. · by wowlua `(isMuted: boolean)`	guessed
`SetOutputDevice`	Sets the audio output device for voice chat. · by wowlua `(deviceID: string)`	guessed
`SetOutputVolume`	Sets the voice chat output volume. · by wowlua `(volume: number)`	guessed
`SetPortraitTexture`	Sets a texture to the portrait of a voice chat channel member. · by wowlua `(textureObject: Texture, memberID: VoiceChatID, channelID: VoiceChatID)`	guessed
`SetPushToTalkBinding`	Sets the keys bound to push-to-talk. · by wowlua `(keys: string[])`	guessed
`SetVADSensitivity`	Sets the voice activation sensitivity. · by wowlua `(sensitivity: number)`	guessed
`ShouldDiscoverChannels`	Use this while loading to determine if the UI should attempt to rediscover the previously joined/active voice channels `(): boolean`	guessed
`SpeakRemoteTextSample`	Speaks a text sample with the remote text-to-speech voice. · by wowlua `(text: string)`	guessed
`SpeakText`	Reads text to speech. `(voiceID: number, text: string, rate: number, volume: number, overlap: boolean)`	guessed
`StopSpeakingText`	Stops text-to-speech that is speaking. · by wowlua `()`	guessed
`ToggleDeafened`	Toggles whether voice chat is deafened. · by wowlua `()`	guessed
`ToggleMemberMuted`	Toggles whether the player has muted a voice chat member. · by wowlua `(playerLocation: PlayerLocationMixin)`	guessed
`ToggleMuted`	Toggles whether the player's microphone is muted. · by wowlua `()`	guessed

"by wowlua": no one documents this function, so wowlua wrote the description from its name, signature and behaviour.

Events

event	payload	fired by the emulator
`VOICE_CHAT_ACTIVE_INPUT_DEVICE_UPDATED`	`no payload`	not implemented
`VOICE_CHAT_ACTIVE_OUTPUT_DEVICE_UPDATED`	`no payload`	not implemented
`VOICE_CHAT_ACTIVE_VOICE_PROVIDER_CHANGED`	`voiceProviderID: VoiceProviderID`	not implemented
`VOICE_CHAT_AUDIO_CAPTURE_ENERGY`	`isSpeaking: boolean, energy: number`	not implemented
`VOICE_CHAT_AUDIO_CAPTURE_STARTED`	`no payload`	not implemented
`VOICE_CHAT_AUDIO_CAPTURE_STOPPED`	`no payload`	not implemented
`VOICE_CHAT_CHANNEL_ACTIVATED`	`channelID: VoiceChatID`	not implemented
`VOICE_CHAT_CHANNEL_DEACTIVATED`	`channelID: VoiceChatID`	not implemented
`VOICE_CHAT_CHANNEL_DISPLAY_NAME_CHANGED`	`channelID: VoiceChatID, channelDisplayName: string`	not implemented
`VOICE_CHAT_CHANNEL_JOINED`	`status: VoiceChatStatusCode, channelID: VoiceChatID, channelType: ChatChannelType, clubId: ClubId?, streamId: ClubStreamId?`	not implemented
`VOICE_CHAT_CHANNEL_MEMBER_ACTIVE_STATE_CHANGED`	`memberID: VoiceChatID, channelID: VoiceChatID, isActive: boolean`	not implemented
`VOICE_CHAT_CHANNEL_MEMBER_ADDED`	`memberID: VoiceChatID, channelID: VoiceChatID`	not implemented
`VOICE_CHAT_CHANNEL_MEMBER_ENERGY_CHANGED`	`memberID: VoiceChatID, channelID: VoiceChatID, speakingEnergy: number`	not implemented
`VOICE_CHAT_CHANNEL_MEMBER_GUID_UPDATED`	`memberID: VoiceChatID, channelID: VoiceChatID`	not implemented
`VOICE_CHAT_CHANNEL_MEMBER_MUTE_FOR_ALL_CHANGED`	`memberID: VoiceChatID, channelID: VoiceChatID, isMutedForAll: boolean`	not implemented
`VOICE_CHAT_CHANNEL_MEMBER_MUTE_FOR_ME_CHANGED`	`memberID: VoiceChatID, channelID: VoiceChatID, isMutedForMe: boolean`	not implemented
`VOICE_CHAT_CHANNEL_MEMBER_REMOVED`	`memberID: VoiceChatID, channelID: VoiceChatID`	not implemented
`VOICE_CHAT_CHANNEL_MEMBER_SILENCED_CHANGED`	`memberID: VoiceChatID, channelID: VoiceChatID, isSilenced: boolean`	not implemented
`VOICE_CHAT_CHANNEL_MEMBER_SPEAKING_STATE_CHANGED`	`memberID: VoiceChatID, channelID: VoiceChatID, isSpeaking: boolean`	not implemented
`VOICE_CHAT_CHANNEL_MEMBER_STT_MESSAGE`	`memberID: VoiceChatID, channelID: VoiceChatID, message: string, language: string`	not implemented
`VOICE_CHAT_CHANNEL_MEMBER_VOLUME_CHANGED`	`memberID: VoiceChatID, channelID: VoiceChatID, volume: number`	not implemented
`VOICE_CHAT_CHANNEL_MUTE_STATE_CHANGED`	`channelID: VoiceChatID, isMuted: boolean`	not implemented
`VOICE_CHAT_CHANNEL_PTT_CHANGED`	`channelID: VoiceChatID, pushToTalkSetting: string`	not implemented
`VOICE_CHAT_CHANNEL_REMOVED`	`channelID: VoiceChatID`	not implemented
`VOICE_CHAT_CHANNEL_TRANSCRIBING_CHANGED`	`channelID: VoiceChatID, isTranscribing: boolean`	not implemented
`VOICE_CHAT_CHANNEL_TRANSMIT_CHANGED`	`channelID: VoiceChatID, isTransmitting: boolean`	not implemented
`VOICE_CHAT_CHANNEL_VOLUME_CHANGED`	`channelID: VoiceChatID, volume: number`	not implemented
`VOICE_CHAT_COMMUNICATION_MODE_CHANGED`	`communicationMode: CommunicationMode`	not implemented
`VOICE_CHAT_CONNECTION_SUCCESS`	`no payload`	implemented
`VOICE_CHAT_DEAFENED_CHANGED`	`isDeafened: boolean`	implemented
`VOICE_CHAT_DISCORD_SETTINGS_UPDATED`	`no payload`	not implemented
`VOICE_CHAT_ERROR`	`platformCode: number, statusCode: VoiceChatStatusCode`	not implemented
`VOICE_CHAT_INPUT_DEVICES_UPDATED`	`no payload`	implemented
`VOICE_CHAT_LOGIN`	`status: VoiceChatStatusCode`	not implemented
`VOICE_CHAT_LOGOUT`	`status: VoiceChatStatusCode`	not implemented
`VOICE_CHAT_MUTED_CHANGED`	`isMuted: boolean`	implemented
`VOICE_CHAT_OUTPUT_DEVICES_UPDATED`	`no payload`	implemented
`VOICE_CHAT_PENDING_CHANNEL_JOIN_STATE`	`channelType: ChatChannelType, clubId: ClubId?, streamId: ClubStreamId?, pendingJoin: boolean`	not implemented
`VOICE_CHAT_PTT_BUTTON_PRESSED_STATE_CHANGED`	`isPressed: boolean`	not implemented
`VOICE_CHAT_SILENCED_CHANGED`	`isSilenced: boolean`	not implemented
`VOICE_CHAT_SPEAK_FOR_ME_ACTIVE_STATUS_UPDATED`	`no payload`	not implemented
`VOICE_CHAT_SPEAK_FOR_ME_FEATURE_STATUS_UPDATED`	`no payload`	not implemented
`VOICE_CHAT_TTS_PLAYBACK_BOOKMARK`	`utteranceID: number, bookmarkName: string`	not implemented
`VOICE_CHAT_TTS_PLAYBACK_FAILED`	`utteranceID: number, status: VoiceTtsStatusCode`	not implemented
`VOICE_CHAT_TTS_PLAYBACK_FINISHED`	`utteranceID: number`	not implemented
`VOICE_CHAT_TTS_PLAYBACK_STARTED`	`utteranceID: number`	not implemented
`VOICE_CHAT_TTS_SPEAK_TEXT_UPDATE`	`status: VoiceTtsStatusCode, utteranceID: number`	not implemented
`VOICE_CHAT_TTS_VOICES_UPDATE`	`no payload`	not implemented
`VOICE_CHAT_VAD_SETTINGS_UPDATED`	`no payload`	implemented
`VOICE_CHAT_VOICE_PROVIDERS_AVAILABLE_CHANGED`	`no payload`	not implemented
`VOICE_CHAT_VOICE_PROVIDER_CHANGED`	`voiceProviderID: VoiceProviderID`	not implemented

An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("VOICE_CHAT_ACTIVE_INPUT_DEVICE_UPDATED").

Structures

VoiceAudioDevice · deviceID, displayName, isActive, isSystemDefault, isCommsDefault
VoiceChatChannel · name, channelID, channelType, clubId, streamId, volume, isActive, isMuted, isTransmitting, isTranscribing, members
VoiceChatMember · energy, memberID, isActive, isSpeaking, isMutedForAll, isSilenced
VoiceChatProcess · name, channels
VoiceTtsVoiceType · voiceID, name

sources

Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (VoiceChat system, camelot 1.60.1). Descriptions: Blizzard's API documentation (Blizzard_APIDocumentationGenerated); warcraft.wiki.gg's API pages, by its contributors, CC BY-SA 4.0 ↗; written by wowlua where no documentation describes the entry.