The IMCChannelSGN interface is part of the signaling subsystem of the Medialooks SDK. It provides methods to enumerate and manage WebRTC channels and to exchange signaling messages. This interface is typically used in conjunction with
Methods
VTSG_InfoGet
Retrieves metadata about the current signaling peer, including ID, UPI, connection state, and pending messages.
Syntax
void VTSG_InfoGet(out string _pbsUPI, out string _pbsID, out eVTSG_State _peState, out int _pnMessagesHave)
Parameters
_pbsUPI - Output peer UPI (Unique Peer Identifier)
_pbsID - Output peer Channel ID
_peState - Output state of the signaling connection (eVTSG_State)
_pnMessagesHave - Output number of unread signaling messages
VTSG_EnumFind
Finds a specific peer in the signaling channel list using a prefix and either a UPI or channel ID.
Syntax
void VTSG_EnumFind(string _bsPrefix, string _bsFindUPIorID, out string _pbsChannelUPI, out IMAttributes _ppChannelProps)
Parameters
_bsPrefix - Prefix to scope the search (e.g., signaling room name)
_bsFindUPIorID - UPI or ID to match
_pbsChannelUPI - Output matched peer UPI
_ppChannelProps - Output IMAttributes describing the peer
VTSG_EnumGetCount
Returns the number of peers in a given signaling room.
Syntax
void VTSG_EnumGetCount(string _bsPrefix, out int _pnCount, string _bsHints)
Parameters
_bsPrefix - Room or channel prefix to enumerate
_pnCount - Output number of peers
_bsHints - Optional hints (usually left empty)
VTSG_EnumGetByIndex
Retrieves peer information by index within the specified room prefix.
Syntax
void VTSG_EnumGetByIndex(string _bsPrefix, int _nIndex, out string _pbsChannelUPI, out IMAttributes _ppChannelProps)
Parameters
_bsPrefix - Channel prefix or room name
_nIndex - Index of the peer
_pbsChannelUPI - Output peer UPI
_ppChannelProps - Output peer attributes
VTSG_EnumGetChannelProps
Retrieves a specific property value from a peer in the signaling group.
Syntax
void VTSG_EnumGetChannelProps(string _bsPrefix, string _bsChannelUPI, string _bsPropName, out string _pbsPropsValue)
Parameters
_bsPrefix - Channel or room prefix
_bsChannelUPI - Peer UPI
_bsPropName - Name of the property to retrieve
_pbsPropsValue - Output value of the property
VTSG_MessageSend
Sends a named signaling message to another peer.
Syntax
void VTSG_MessageSend(string _bsDestinationUPI, string _bsMessageName, string _bsMessageBody, object _pMessageObj, string _bsHints)
Parameters
_bsDestinationUPI - UPI of the receiving peer
_bsMessageName - Message type or label
_bsMessageBody - Text content of the message
_pMessageObj - Optional attached object
_bsHints - Additional delivery hints
VTSG_MessageTake
Retrieves the next signaling message addressed to the current peer.
Syntax
void VTSG_MessageTake(int _nTimeoutMsec, out string _pbsSourceUPI, out string _pbsMessageName, out string _pbsMessageBody, out object _ppMessageObj)
Parameters
_nTimeoutMsec - Time in milliseconds to wait for a message
_pbsSourceUPI - Output source UPI
_pbsMessageName - Output name of the message
_pbsMessageBody - Output body content
_ppMessageObj - Output attached object (if any)