Documentation

This page lists the API of libraidvoice as in release 0.5

Raidvoice functions

RV:playerStartsSpeaking()

Function notifiing other players that you have started talking. You can call this function or bind it to a push to talk key.

function RV:playerStopsSpeaking()

Function notifiing other players that you have stopped talking. You can call this function or bind it to a push to talk key.

RV:useVoiceActivation(enabled)

enabled = true enables voice activation

enabled = false disables voice activation

Please note that voice activation uses blizzard voicechat to get voice voice sound level, blizzard voicechat must be enabled and voice activation sensitivity set in game options, otherwise this doesnt work.

If voice level changes from previous value, RV:playerStartsSpeaking() or RV:playerStopsSpeaking() are called accordingly.

function RV:setVoiceUpdatePeriod(period)

Sets how often is voice level checked, if you do not call this function default value is 2 seconds. Minimum permitted value is 0.5s as I am afraid of spamming addon channel with voice updates.

RV:UnitIsRaidVoiceCapable(name)

return 1 if player has this library (he can see you speak), please note that the correct value is NOT immediately available after joining party/raid, there is a short delay caused by query to the party members. (about 200ms)

function RV:SetVoiceChannel(index)

provides Voice channel selection, the default value if function is not called is 0 (party/raid)

you can set this value to any positive number to use virtual voice channels over guildchat.

Please note you can be in only one channel at once (setting this value means you will not see people speaking in party/raid)

- number 0 is reserved for party/raid

- number 100 is reserved for battleground

- numbers 1-5 were tested and works

Global functions

UnitIsTalking(playerName)

returns 1 if player is talking on external voicechat and has raidvoice, or if he is talking over blizzard voicechat

return nil if he is not talking