1.2.1 List of All Sessions
Enter this command to list all existing sessions along with the following information: session ID, session name, flags, stream priority, session channel, session output volume, session output balancing value, time during which the volume or balance change is effective, if requested, console panel parameters.
Request
<msg Id="CTI_NSPK_GET_ALL_SESSIONS_REQ">
<CTI_IE_REFERENCE Ref="0x420"/>
</msg>
Response
<msg Id="CTI_NSPK_GET_ALL_SESSIONS_CONF">
<CTI_IE_REFERENCE Ref="0x420"/>
<CTI_NSPK_IE_SESSION SessionId="0x4" Name="My session" Flags="0x0" Priority="1" Channel="0" MasterVolume="4032" MasterBalance="0" MasterFadeTime="0" PanelUserId="0xFFFFFFFF" PanelMode="USER" PanelVirtualInputId="0xFFFFFFFF" FreeRideId="0xFFFFFFFF"/>
<CTI_NSPK_IE_SESSION SessionId="0x5" Name="New session (1)" Flags="0x0" Priority="1" Channel="0" MasterVolume="4096" MasterBalance="0" MasterFadeTime="0" PanelUserId="0xFFFFFFFF" PanelMode="USER" PanelDelay="40" PanelVirtualInputId="0xFFFFFFFF" FreeRideId="0xFFFFFFFF"/>
</msg>
IE
<documentation IE="CTI_NSPK_IE_SESSION">
<member Type="INT" Name="SessionId" Brief="Primary key session"/>
<member Type="CHAR" Name="Name" Brief="Session name"/>
<member Type="U32" Name="Flags" Brief="Flags by NSPK_SES_E_SESSION_FLAGS - use bit adding"/>
<member Type="INT" Name="Priority" Brief="Priority of stream, which is session output (when more streams comes into one speaker, selected is that with biggest priority)"/>
<member Type="INT" Name="Channel" Brief="Channel - for stream choice at speaker"/>
<member Type="INT" Name="MasterVolume" Brief="Output volume"/>
<member Type="INT" Name="MasterBalance" Brief="Output balance"/>
<member Type="INT" Name="MasterFadeTime" Brief="Time during which the volume or balance change is effective, if requested, in ms"/>
<member Type="INT" Name="PanelUserId" Brief="Only for console panel, ID of user, logged to session server"/>
<member Type="NSPK_SES_E_PANEL_MODE" Name="PanelMode" Brief="Only for console panel, panel connection mode"/>
<member Type="INT" Name="PanelDelay" Brief="Only for console panel, delay of sound path"/>
<member Type="INT" Name="PanelVirtualInputId" Brief="Only for console panel, virtual input ID to connect panel to"/>
<member Type="INT" Name="FreeRideId" Brief="ID of record in freeride mode"/>
</documentation>
<documentation IE="CTI_NSPK_IE_SESSION_ID">
<member Type="INT" Name="SessionId" Brief="Primary key session"/>
</documentation>
<documentation Bitfield="NSPK_SES_E_SESSION_FLAGS">
<item Value="0x1" Brief="Determines, if session is active"/>
<item Value="0x2" Brief="Determines, if session is muted"/>
</documentation>
<documentation Enum="NSPK_SES_E_PANEL_MODE">
<item Name="USER" Brief="User mode, in table SESSION_DEST be used only records with type LOCAL_HW, transmit as PanelUserId"/>
<item Name="VIRTUAL_INPUT" Brief="Virtual input mode, in table SESSION_DEST be used only records with type LOCAL_HW, transmit as PanelVirtualInputId"/>
<item Name="FREE_RIDE" Brief="At server will be created extra session with PanelUserId input and output will be enumerated records from table SESSION_DEST"/>
</documentation>