- V3_EVENT_STATUS
- A status event, sent during long running operations to increment a status bar
- Contains:
- event.status.percent - Percent complete
- event.status.text - Status text of what is currently happening
- V3_EVENT_PING
- The server has updated the current ping value
- Contains:
- event.ping - The current ping value
- V3_EVENT_USER_LOGIN
- A user has logged in to the server or a phantom has been added
- Contains:
- event.user.id - The user id (number) of the new user
- event.channel.id - The channel id that the user is in
- event.flags - A bit field containing additional information
- If the user is being added at login, the V3_LOGIN_FLAGS_EXISTING will be set
- V3_EVENT_USER_LOGOUT
- A user has logged off of the server or a phantom has been removed
- Contains:
- event.user.id - The user id (number) of the user
- event.channel.id - The channel id that the user was in
- V3_EVENT_LOGIN_COMPLETE
- The local user has successfully logged into the server
- V3_EVENT_USER_CHAN_MOVE
- A user has changed channels
- Contains:
- event.user.id - The user id (number) of the user
- event.channel.id - The channel id of the user's new channel
- V3_EVENT_CHAN_ADD
- A channel has been added to the server
- Contains:
- event.channel.id - The channel id of the new channel
- V3_EVENT_CHAN_MODIFY
- A channel has been modified on the server
- Contains:
- event.channel.id - The channel id of the channel that was modified
- V3_EVENT_CHAN_REMOVE
- A channel has been removed from the server
- Contains:
- event.channel.id - The channel id of the channel that was removed
- V3_EVENT_CHAN_BADPASS
- A channel change was requested by the client, but the supplied password is incorrect
- Contains:
- event.channel.id - The channel id the user attempted to change to
- event.error.message - A string containing the error text
- V3_EVENT_ERROR_MSG
- An generic error message was sent by the server
- Contains:
- event.error.message - A string containing the error text
- event.error.disconnected - Non-zero if the error caused the user to be disconnected from the server
- V3_EVENT_USER_TALK_START
- A user started transmitting audio data
- Contains:
- event.user.id - The user id that started transmitting
- event.pcm.send_type - The type of transmission (user-to-user, channel, channel and subchannels, etc)
- event.pcm.rate - The PCM rate (in Hz) that the user is sending
- V3_EVENT_USER_TALK_END
- A user stopped transmitting audio data
- Contains:
- event.user.id - The user id of the user that stopped transmitting
- V3_EVENT_PLAY_AUDIO
- Audio data that needs to be played
- Contains:
- event.user.id - The user id of the user that stopped transmitting
- event.pcm.send_type - The type of transmission (user-to-user, channel, channel and subchannels, etc)
- event.pcm.rate - The PCM rate (in Hz) that the user is sending
- event.pcm.length - The length in bytes of the audio data in the event
- event.data.sample - The PCM data as a an array of unsigned 8 bit integers
- event.data.sample16 - The PCM data as a an array of signed 16 bit integers. Note that the the PCM length is in bytes, not samples. The number of samples will be event.pcm.length / 2
- V3_EVENT_DISPLAY_MOTD
- The MOTD to display to the user
- Contains:
- event.data.motd - The MOTD text
- V3_EVENT_USER_MODIFY
- A user has been modified. This event occurs when a user changes their comment, url, etc.
- Contains:
- ev.user.id - The user id that was modified
- ev.text.comment - The user's comment
- ev.text.url - The user's URL
- ev.text.integration_text - The user's music player integration text
- V3_EVENT_CHAT_JOIN
- A user has joined global chat
- Contains:
- ev.user.id - The user id that joined chat
- V3_EVENT_CHAT_LEAVE
- A user has left global chat
- Contains:
- ev.user.id - The user id that left chat
- V3_EVENT_CHAT_MESSAGE
- A user has sent a global chat message
- Contains:
- ev.user.id - The user id that sent the message
- ev.data.chatmessage - The text of the chat message
- V3_EVENT_PHANTOM_ADD
- A phantom has been added
- Contains:
- ev.user.id - The user id of the phantom
- ev.channel.id - The channel id the phantom is in
- V3_EVENT_PHANTOM_REMOVE
- A phantom has been removed
- Contains:
- ev.user.id - The user id of the phantom
- ev.channel.id - The channel id the phantom was in
- V3_EVENT_ADMIN_AUTH
- The local user has authenticated as a server administrator
- V3_EVENT_CHAN_ADMIN_UPDATED
- The channels the local user has admin rights to have been updated
- V3_EVENT_USERLIST_ADD
- The userlist entry was added.
- Contains:
- ev.account.id - The account id of the new account
- V3_EVENT_USERLIST_REMOVE
- The userlist entry was removed.
- Contains:
- ev.account.id - The account id of the removed account
- V3_EVENT_USERLIST_MODIFY
- The userlist entry was modified.
- Contains:
- ev.account.id - The account id of the modified account
- V3_EVENT_USERLIST_CHANGE_OWNER - only used internally
- V3_EVENT_CHANGE_CHANNEL - only used internally
- V3_EVENT_DISCONNECT - only used internally
Download in other formats: