MM Remote Interface Description en MM Remote Interface Description
MM Remote Interface Description en | 2 Table of Contents 1 1.1 1.2 1.3 1.4 1.5 2 2.1 2.2 2.3 3 3.1 3.2 3.3 3.4 3.5 3.6 3.7 3.8 4 4.1 4.2 Introduction ........................................................................................................................................4 Purpose ..........................................................................................................................................4 Scope...........................................................
MM Remote Interface Description en | 3 4.2.2 MM_C_SET_ACTIVE_MICS_ON_PC...............................................................................28 4.2.3 MM_C_SET_SETTINGS_ON_PC.....................................................................................28 4.3 MM Speaker list notifications........................................................................................................28 4.3.1 MM_C_MICRO_ON_OFF ............................................................................
MM Remote Interface Description 1 Introduction 1.1 Purpose en | 4 The purpose of this document is to describe the remote interface for microphone management between the CCU and third party software. 1.2 Scope This document describes the remote interface for microphone management. It is meant for developers who want to use this remote interface to control the microphone management application, present in the CCU, remotely.
MM Remote Interface Description 2 Microphone management for a Remote interface 2.1 Introduction en | 5 The Microphone Management Remote Interface is part of the DCN software which allows for another controlling entity outside the CCU, not being the DCN Control PC, to use the Microphone Management application. 2.2 Remote Microphone Management Control Microphone Management is the application that allows for controlling the microphones in the conference hall. Typical control issues are e.g.
MM Remote Interface Description Request to Speak list Comment Request list Comment Speakers list en | 6 their microphone switched on. Depending on the operation mode it is possible that a unit is in the speakers list with its microphone switched off. The speakers list exists in all operation modes except for the mode Delegate with Voice activation. The request to speak list contains the unit/delegate combinations that requested to have their microphone switched on so they can speak.
MM Remote Interface Description Mode OPERATOR WITH REQUEST LIST equals MM_C_OPERATOR_WITH_REQ_LIST en | 7 Mode description & Group enable/disable Manual mode. The operator (using the remote controller) controls the RTS list. Delegates are always added to the RTS list and the operator determines which delegate may speak. Special features are to disable the cancel of an request and to turn off the microphone by the delegates (see section 3.2.
MM Remote Interface Description en | 8 The RTS functions and notifications mentioned in the table are described in respectively. sections 3.5.4 and 4.6. The CR functions and notifications mentioned in the table are described in respectively. sections 3.7 and 4.7. Bosch Security Systems B.V.
MM Remote Interface Description 3 Remote Functions 3.1 Introduction en | 9 This chapter describes the various remote functions needed to perform microphone management on the system. 3.1.1 Preconditions The remote functions for the MM application acting on any of the microphone lists always use the UnitId to perform the requested functionality. For the Request to speak list or Comment Request list functions also a DelegateId is required.
MM Remote Interface Description en | 10 called, it contains the value 1. Error codes returned MM_E_NOERROR MM_E_OPEN_CLOSE_FAILED Related functions MM_C_STOP_MM 3.2.2 MM_C_STOP_MM Purpose Indicates the CCU that the remote controller no longer requires updates from the MM application inside the CCU. After receiving this function the CCU decrements the update use count. As long as the update use count is still greater than zero, the CCU remains sending the update notifications to the remote controller.
MM Remote Interface Description en | 11 function is called, it contains the value 1. Error codes returned MM_E_NOERROR Related functions MM_C_STOP_MM MM_C_STOP_MON_MM 3.2.4 MM_C_STOP_MON_MM Purpose Function to stop monitoring the behaviour of the Microphone Management application. Parameter structure for the function The function has no additional parameters. Response structure from the function The function returns the same response structure as the remote function MM_C_START_MON_MM (section 3.2.
MM Remote Interface Description en | 12 When the microphone operation-mode equals MM_C_OPERATOR_WITH_COMMENT_LIST and the maximum number of active microphones is increased to more than 1 an error is returned. Parameter structure for the function The function requires the following structure as parameter: WORD wActiveMics; where: wActiveMics The number of active microphones which can be on at the same time. Valid values are in the range 1..4.
MM Remote Interface Description en | 13 implies that the micro can only be turned off by the remote controller. (only valid for the operation modes MM_C_OPERATOR_WITH_REQ_LIST and MM_C_OPERATOR_WITH_COMMENT_LIST). bAttentionTone TRUE: An attention tone is generated when the priority key is pressed on a chairman-unit. FALSE: No attention is generated when the priority key is pressed. bAmbientMicCtrl TRUE: The ambient microphone control is enabled. Ambient mic. control means that the ambient mic.
MM Remote Interface Description (already in the SPK list) Chairman unit micro on Chairman unit micro off en | 14 the SPK list. The units microphone is turned on. The units microphone is turned off. Parameter structure for the function The function requires the following structure as parameter: typedef struct { WORD wUnitId; BOOLEAN bMicroOn; } MM_T_MICRO_ONOFF; where: wUnitId Unit Identifier. Unit identifiers can be retrieved from the system using the remote functions for System Config [SRS_SCSIINF].
MM Remote Interface Description en | 15 Update notifications MM_C_SPK_APPEND_ON_PC Related functions MM_C_SPK_REMOVE 3.3.3 MM_C_SPK_REMOVE Purpose Removes a speaker from the SPK list on the CCU. A removal of a unit from the SPK list automatically implies that the units microphone will be turned off. Parameter structure for the function This function requires the structure MM_T_SPK as parameter. This structure is defined in section 3.3.2.
MM Remote Interface Description en | 16 DBSC_MAX_SPEAKERLIST. Array holding the SPK list information. Each array element is defined as a MM_T_SPK_MICRO structure which is defined below. tSpkList [] wUnitId Unit identifier bMicroOn TRUE if the microphone is currently on FALSE if the microphone is currently off Error codes returned MM_E_NOERROR Related functions MM_C_SPK_APPEND 3.4 MM Comment Speaker list functions This section describes the functions to manipulate the comment speakers list.
MM Remote Interface Description 3.5 en | 17 MM Notebook list functions This section describes the functions to manipulate the Notebook list. 3.5.1 MM_C_NBK_REMOVE Purpose Remove one entry from the Notebook as present in the CCU. Parameter Structure for the function The function requires the MM_T_NBK structure for input. This structure is defined in section 4.5.1. Response structure from the function The function has no response parameters.
MM Remote Interface Description en | 18 below. wUnitId Unit Identifier wMicroType The type of microphone handling for the notebook entry.
MM Remote Interface Description en | 19 • • • • • MM_C_CHAIRMAN_NO_AC MM_C_KEY_NO_AC MM_C_OPERATOR_NO_AC MM_C_VOICE_NO_AC MM_C_VCHAIR_NO_AC In a typical, stand alone, configuration the notebook contains only the chairman units, which appear as MM_C_VIP_CHAIRMAN entries in the notebook list. Other type of notebook entries can only be added using a DCN Control PC. Response structure from the function The function has no response parameters.
MM Remote Interface Description en | 20 Error codes returned MM_E_NOERROR MM_E_ILLEGAL_MIC_OPER_MODE MM_E_UNKNOWN_UNITID_AND_DELID MM_E_UNIT_ALREADY_PRESENT MM_E_UNIT_NOT_CONNECTED MM_E_UNITID_DELID_MISMATCH MM_E_RTS_LIST_FULL Update notifications MM_C_RTS_INSERT_ON_PC MM_C_RTS_FIRST_ON_PC (if appended delegate becomes the first in the list) Related functions MM_C_RTS_REMOVE MM_C_RTS_CLEAR 3.6.2 MM_C_RTS_REMOVE Purpose Remove one delegate/unit combination from the RTS list on the CCU.
MM Remote Interface Description en | 21 Response structure from the function The function returns the following structure: typedef struct { WORD wNrOfRts; MM_T_RTS tRtsList[DBSC_MAX_DELRTS]; } MM_T_CCU_RTSLIST; where: wNrOfRts The number of RTS list entries actual present in the tRtsList array. Only this amount of array elements are transmitted. This value never exceeds the constant DBSC_MAX_DELRTS. tRtsList [ ] Array holding the RTS list information.
MM Remote Interface Description en | 22 Parameter structure for the function The function requires the structure MM_T_RTS as parameter. This structure is defined in section 3.6. Normally the provided RTS list entry defines which delegate/unit combination is candidate to shift to the speakers list. When the provided RTS is filled with empty values (wUnitId = DBSC_EMPTY_UNIT and wDelegateId = DBSC_EMPTY_DELEGATE), the first RTS entry present in the RTS list is used.
MM Remote Interface Description en | 23 WORD wNrOfCR; MM_T_RTS tCRList[DBSC_MAX_DELCR]; } MM_T_CCU_CRLIST; where: wNrOfCR The number of CR list entries actual present in the tCRList array. This value never exceeds the constant DBSC_MAX_DELCR. tCRList [ ] Array holding the CR list information. Each array element is defined as a MM_T_RTS structure which is defined in section 3.6. Error codes returned MM_E_NOERROR MM_E_ILLEGAL_MIC_OPER_MODE Related functions MM_C_RTS_CLEAR_COMMENT 3.7.
MM Remote Interface Description 3.8.1 en | 24 MM_C_SET_SPEECHTIME_SETTINGS Purpose This function stores the speechtime settings in the CCU.
MM Remote Interface Description en | 25 where: wUnitId The unit on which to place the message. Response structure from the function This function has no response parameters. Error codes returned MM_E_NOERROR MM_E_UNKNOWN_UNIT Related functions MM_C_SET_SPEECHTIME_SETTINGS MM_C_LAST_MINUTE_WARNING Bosch Security Systems B.V.
MM Remote Interface Description 4 Update Notifications 4.1 Introduction en | 26 This chapter describes the various update notifications sent by the CCU. All the update notifications of the MM application are listed in this chapter. 4.1.1 Update notification item explanation Each update notification description consists of the following items: • Purpose A global description of the purpose of the notification. • Notify structure with this update The information passed with the update notification.
MM Remote Interface Description UNIT-EVENT MATRIX Input event C: Chairman D: Delegate C: Microphone On C: Microphone Off C: Priority On C: Priority Off D: Request to Speak D: Cancel Req. to Speak D: Microphone Off D: Comment Request D: Cancel Comment Request C: Cancel all speakers C: Cancel all requests Delegate with Req.List en | 27 Operational Mode Operator with Req.
MM Remote Interface Description en | 28 Note that a delegate does not really turns on its microphone, but he makes a Request to speak. Depending on the operation mode and the current lists, he is added to the SPK list or the RTS list. On this Request-toSpeak-event also a remark has to be made if the unit/delegate is in the Speakerslist but with the microphone off (which is possible with the function MM_C_SET_MICRO_ON_OFF, see section 3.3.1).
MM Remote Interface Description en | 29 • MM_C_PC_PRIO_OFF • MM_C_PC_PRIO_NONE The ‘NONE’ values of the parameters ‘wMicroId’ and ‘wPrioId’ indicate that the specific parameter is not used. Examples To illustrate the values of the parameters ‘wMicroId’ and ‘wPrioId’ the following value for these parameters are returned with the events: wMicroId wPrioId Delegate micro ON MM_C_PC_MIC_ON MM_C_PC_PRIO_NONE 4.3.
MM Remote Interface Description 4.3.6 en | 30 MM_C_SPK_REMOVE_ON_PC Purpose Notifies the remote controller that a unit is removed from the SPK list (including turning off the microphone). Notify structure with this update The update comes with the following structure: MM_T_SPK tSpkRemove; where: The speaker who is removed from the speakers list. The structure MM_T_SPK is defined in section 3.3.2. tSpkRemove 4.3.
MM Remote Interface Description en | 31 where: tCSpkAdd 4.4.3 The speaker who is added to the comment speakers list. The structure MM_T_SPK is defined in section 3.3.2. MM_C_CS_REMOVE_ON_PC Purpose Notifies the remote controller that a unit is removed from the SPK list (including turning off the microphone). Notify structure with this update The update comes with the following structure: MM_T_SPK tCSpkRemove; where: tCSpkRemove 4.5 The speaker who is removed from the comment speakers list.
MM Remote Interface Description 4.6.3 en | 32 MM_C_RTS_REMOVE_ON_PC Purpose Notifies the remote controller that a delegate/unit combination is removed from the RTS list. Notify structure with this update The update comes along with a MM_T_RTS structure which indicates the delegate/unit combination to be removed. The structure MM_T_RTS is defined in section 3.6. 4.6.4 MM_C_RTS_FIRST_ON_PC Purpose Notifies the remote controller which delegate/unit combination is the first in the list.
MM Remote Interface Description 4.7 en | 33 MM Comment Request list notifications The Microphone Management Comment Request notifications report the remote controller the changes in the CR list. 4.7.1 MM_C_CR_CLEAR_ON_PC Purpose Notifies the remote controller that the CR list is cleared. Notify structure with this update The update does not have any additional parameters. 4.7.2 MM_C_CR_ADD_ON_PC Purpose Notifies the remote controller that a delegate/unit combination is added to the CR list.
MM Remote Interface Description en | 34 APPENDIX A. VALUES OF THE DEFINES In this document a lot of definitions are given, which have values connected to them.
MM Remote Interface Description #define #define #define #define en | 35 MM_C_PC_MIC_NONE MM_C_PC_PRIO_ON MM_C_PC_PRIO_OFF MM_C_PC_PRIO_NONE 3 1 2 3 #define MM_C_VIP_CHAIRMAN #define MM_C_VIP_KEY 1 2 #define MM_C_VIP_OPERATOR 3 #define MM_C_VIP_VOICE 4 #define MM_C_VIP_VCHAIR #define MM_C_CHAIRMAN_NO_AC #define MM_C_KEY_NO_AC 5 6 7 #define MM_C_OPERATOR_NO_AC 8 #define MM_C_VOICE_NO_AC 9 #define MM_C_VCHAIR_NO_AC 10 (Chairman) (Delegate set as Key activated notebooker) (Delegate set as Ope
MM Remote Interface Description en | 36 APPENDIX B. ERROR CODES Responses returned upon a remote function request contain a error field (‘wError’). In this appendix an overview is given of the possible errors and their values. Microphone Management Error code Value Explanation 0 MM_E_NOERROR The execution of the remote function was successful. 5 MM_E_OPEN_CLOSE_FAILED The internal database on the CCU was not able to update the total use count for the MM application.
MM Remote Interface Description Microphone Management Error code Value Explanation remove on a RTS list entry on an empty RTS list. 27 MM_E_ILLEGAL_MAX_RTS_LIST_LEN The maximum length provided for the RTS list is out of range. Valid values for the RTS list length are within the range 0..100. 28 MM_E_RTS_LIST_TOO_BIG The RTS list provided is too big to store it. None of the RTS entries provided is put into the RTS list and the old RTS list remains active.
MM Remote Interface Description en | 38 APPENDIX C. EXAMPLES In the example below the remote functions and update notifications, that are defined in this document as constant values for the wFnId parameter of the message (see [SRS_INF]), are presented as functions described in a ‘C’ syntax. The parameter structures of these functions are according the input, output or notify structures described in the appropriate section.
MM Remote Interface Description en | 39 tMMSettings.wMaxRTSListLen = 50; bMustSend = TRUE; } /* Set new settings if we have to */ if (bMustSend) { error = MM_Set_Settings(&tMMSettings); if (error != MM_E_NOERROR) { /* do error handling */ } } Setting new settings also results in an update notification, so the last thing to do is to check if our settings are accepted by the CCU.
For more information please visit www.boschsecuritysystems.com © 2003 Bosch Security Systems B.V.
