API > Room > OnAudioChannelUpdate

---

Room.OnAudioChannelUpdate

Read-Only

This property is Read-Only

Name	Type
OnAudioChannelUpdate	EventHandler

Event callback function requirement

Info

This property is an event. It means that you need to add a listener function to it. Here how that function needs to look like.

function(MLAudioChannelPolicy channelPolicy);

Parameters

Name	Type	Description
channelPolicy	MLAudioChannelPolicy	The Channel policy which updated.

Usage

--- callback function called when event triggers
--- @param mlaudiochannelpolicy MLAudioChannelPolicy
local function CallBack(mlaudiochannelpolicy)
    -- code to handle event call back
end


-- Regsiter callback function
Room.OnAudioChannelUpdate.Add(CallBack);

Description

Called when channel policy gets updated on the server.

Example

This callback gets called on the local clients.

---@param policy MLAudioChannelPolicy
local function onAudioChannelUpdate(policy)

end

Room.OnAudioChannelUpdate.Add(onAudioChannelUpdate);