DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.4 en | 3 Table of sections General Description...................................................................................................................5 System Configuration, System Installation and Database ...........................35 Microphone Management ...................................................................................................79 Camera Control ..............................................................................
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.4 General en | 6 Table of Contents 1. Introduction ............................................................................................................................................. 8 1.1 Purpose......................................................................................................................................... 8 1.2 Scope..............................................................................................................
DCN Next Generation Open Interface Release 2.4 General en | 7 A.1. Protocol Settings Single CCU (DCN-CCU or DCN-CCUB) ...................................................... 31 A.2. TCP/IP port setting MCCU-Master (DCN-NCO) ....................................................................... 32 Appendix B. Values of the defines .......................................................................................................... 33 Appendix C. Error Codes ............................................
DCN Next Generation Open Interface Release 2.4 General 1. INTRODUCTION 1.1 Purpose The purpose of this document is to describe the general remote interface aspects for any application to be remotely controlled on the CCU by third party software. 1.2 Scope This Software Requirements Specification describes the general aspects for the remote interface. It is meant for developers who want to use this remote interface to control applications present in the CCU.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.4 General en | 10 2. SYSTEM SETUP To interface with applications present in the CCU, we will use a serial port present on the CCU (in case of a multi-CCU system, the serial port or the Ethernet port of the master CCU is used). DCN NG Control PC RS-232* ACN CCU RS-232* DCN NG network Remote Controller * or TCP/IP over Ethernet in case of MCCU Figure 1 Hardware configurations remote controls The device (PC, embedded controller, etc.
DCN Next Generation Open Interface Release 2.4 General en | 11 2.2 Requirements As mentioned above the remote controller can be connected to a serial port of the CCU and the TCP/IP port of the NCO. For the remote controller the following hardware requirements are needed for the systems2: ⇒ Single CCU system (LBB4100/00): This type of CCU has 2 serial ports. An RS232 cable with 1 to 1 wiring (RS-232 extension cable, see Figure 2) is used to connect the CCU to the remote controller.
DCN Next Generation Open Interface Release 2.4 General en | 12 3. MESSAGE FORMAT The communication used between the remote controller and the CCU is based on messages. This chapter describes the format of the message and the different message types used to transport data between the remote controller and the CCU. 3.1 Conventions In the sections and chapters below several structures are defined. To prevent problems these structures are defined using standard data types, which have defined sizes and usage.
DCN Next Generation Open Interface Release 2.4 General en | 13 3.2.1 Format of type MDSC_REMOTEPROCEDURE_REQ Remote functions are messages, which are always transmitted to the CCU. The message type must be equal to the value ‘MDSC_REMOTEPROCEDURE_REQ’. The “message data” transmitted for a remote function follows the following format: typedef struct { WORD wFnId; REQSTRUC tStructure; } RSMT_REMOTEPROCEDURE_REQ; // function identifier // function parameters if any! where: wFnId The function identifier.
DCN Next Generation Open Interface Release 2.4 General en | 14 The actual structure definition to be received after handling a remote function request is not described in this document. The structures are presented along with the definition of the remote function in the interface documents for the application. 3.2.3 Format of type MDSC_NOTIFY Upon a status change the CCU reports this change by sending an update notification to the remote controller.
DCN Next Generation Open Interface Release 2.4 General en | 15 the range 0-1000. The value 0 (zero) implies that the heartbeat check will be turned off. Note that heartbeat message is still allowed (for synchronisation purposes). wNrRetries The number of retries to be done before the packet will be discarded. Valid values are in the range 0-10. Note that this count includes the retransmission upon the reception of a NAK-packet.
DCN Next Generation Open Interface Release 2.4 General en | 16 3.3.1 Format of type MESSAGETYPE_OIP_KeepAlive Purpose: The heartbeat message is a special message, which can be sent to the DCN NG System at any time. In normal circumstances the heartbeat message is transmitted every 5 seconds (when nothing else to transmit). The message is used to notify the DCN NG System that your system is still alive. The DCN NG System also sends heartbeat messages to indicate that the DCN NG System is still operational.
DCN Next Generation Open Interface Release 2.4 General dwErrorPosition en | 17 The byte offset in the message stream, where the fault is detected. Related messages: Any message received by the DCN NG System and is not conform the message guideline as described in 3.3. 3.3.3 Format of type MESSAGETYPE_OIP_Dcn Command messages can be sent to control the DCN NG System. Commands always result in a response from the DCN NG System.
DCN Next Generation Open Interface Release 2.4 General en | 18 4. PROTOCOL DESCRIPTION 4.1 Serial Line Protocol Description The message described in the previous chapter must be transmitted between the CCU and the remote controller. The transmission mechanism uses a protocol to detect errors on the communication line. For the serial communication there are three protocols available: • a ‘terminal’ protocol This is not actually a protocol used for data communication.
DCN Next Generation Open Interface Release 2.4 General en | 19 ACK and NAK packets follow the general data packet format without the message information. The ACK and NAK header formats are described in §4.1.2.1. ⇒ A message is expected to be sent as one block. The CCU checks if each byte is received within 50 ms of the previous byte. If not, a NAK-packet will be sent. ⇒ Upon reception of a NAK-packet the last transmitted message is resent again. ⇒ Each message includes a sequence number.
DCN Next Generation Open Interface Release 2.4 General en | 20 packet. That sequence number must be used to acknowledge the packet. ‘@’ Defines the acknowledge packet (ACK). The packet only consists of the header and the checksum. No data is present within this packet. This packet acknowledges the data-message identified with the sequence number passed within the header. ‘#’ Defines the negative acknowledge packet (NAK). The packet only consists of the header and the checksum.
DCN Next Generation Open Interface Release 2.4 General en | 21 4.1.2.3 Escape Byte handling To identify the header uniquely within a stream of bytes is difficult, because the data may also hold the same sequence as the header. Therefore an escape byte is used to make the header unique. The escape byte holds the value 0xC8. Because the data to be transmitted could also contain the escape value, this implies that the data must be scanned to translate the escape value into an escape sequence.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.4 General en | 23 • An expected sequence number The receiving side is expecting either a data-packet or a heartbeat message. In this case the receiving side has no pending message (see Figure 3 where no message is marked), so no acknowledge is expected. The sending side of the communication line responds on this NAK-packet by retransmitting the data-packet. When no data-packet is pending a heartbeat should be retransmitted.
DCN Next Generation Open Interface Release 2.4 General en | 24 • Simultaneously transmission on both sides This kind of problem arises when Controlling PC CCU both sides of the communication Req. Message Upd. Message line sent a message and one of the messages fails due to transmission errors (see Figure ACK Ignored 4). In this case the badly received request-message is assumed to be an ACK-packet. Retry of This packet will be ignored. Req. Message Then the actual ACK-packet is received and accepted.
DCN Next Generation Open Interface Release 2.4 General en | 25 The ‘simple’ feature protocol has also limitations, which are: ∗ There is no communication check. A link-failure cannot be detected by the CCU6. ∗ There is no acknowledgement of the packets received (i.e. no ACK-packets). ∗ The CCU does no retransmission of messages. The NAK-messages are ignored. ∗ The header structure is not uniquely identified.
DCN Next Generation Open Interface Release 2.4 General en | 26 The packet tells the transmitting side of the connection that the last transmitted packet is received with errors (checksum failure). Note that when the CCU is expecting the header of a packet, all received data will be ignored till the complete header is seen. This can happen when the length of a packet is corrupted. (e.g. actual length sent equals 1000 bytes, length received 10 bytes.
DCN Next Generation Open Interface Release 2.4 General During the execution of that remote function in the CCU, the internal state of e.g. microphones changes. This results in the generation of update notifications, which are transmitted to the remote controller immediately. After the completion of the remote function execution the response of that function is sent back to the remote controller.
DCN Next Generation Open Interface Release 2.4 General en | 28 when both controllers call a remote function, both remote functions will be executed one after another (the time difference depends which function will be executed first).
DCN Next Generation Open Interface Release 2.4 General en | 29 5. REMOTE FUNCTIONS 5.1 Remote function handling On the CCU all incoming remote functions are handled by the Remote Function Services (RFS). During start-up of the system applications register their remote controllable functions at the Remote Function Services. When a remote function request is received by the CCU, that request is passed to the RFS sublink.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.4 General en | 31 APPENDIX A. PROTOCOL, SERIAL PORT & TCP/IP SETTING A.1. Protocol Settings Single CCU (DCN-CCU or DCN-CCUB) In this Single CCU configuration two serial ports are available. Both ports can be individually configured.
DCN Next Generation Open Interface Release 2.4 General en | 32 The protocol for port 2 can be set by setting Dip-Switches 5+6 as shown in the following table: Switch Protocol Remark 5 6 off off Simple off on Terminal on off Full on on Camera control The serial port is used with the ‘Simple’ feature protocol as described in §4.1.3. The serial port is used with an ASCII interface. Expected is a terminal to do diagnostics on the CCU.
DCN Next Generation Open Interface Release 2.4 General en | 33 APPENDIX B. VALUES OF THE DEFINES In this document some definitions are given, which have values connected to them.
DCN Next Generation Open Interface Release 2.4 General en | 34 APPENDIX C. 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. Remote Function Services Error code Explanation RFSE_BADFUNCTIONID The remote function called is not registered by the Remote Function Services. Either the function does not exist or the CCU is operating in a wrong mode.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.4 Config Install and Database en | 36 Table of Contents 1. Introduction ........................................................................................................................................... 38 1.1 Purpose....................................................................................................................................... 38 1.2 Scope...........................................................................................
DCN Next Generation Open Interface Release 2.4 Config Install and Database en | 37 6.3 SI_C_OPERATION_MODE........................................................................................................ 63 6.4 SI_C_SLAVE_ID......................................................................................................................... 63 7. Delegate Database (DB) Functions ..................................................................................................... 64 7.
DCN Next Generation Open Interface Release 2.4 Config Install and Database en | 38 1. INTRODUCTION 1.1 Purpose The purpose of this document is to describe the remote interface for system configuration and system installation for the DCN NG system. The document specifies the interface between the CCU and third party software. 1.2 Scope This Software Requirements Specification describes the current state of the remote interface for system configuration and system installation.
DCN Next Generation Open Interface Release 2.4 Config Install and Database en | 39 Appendix B gives an overview of the possible errors that could be returned upon execution of a remote function and a description what went wrong Appendix C shows some examples on typical System Configuration or System Installation topics.
DCN Next Generation Open Interface Release 2.4 Config Install and Database en | 40 2. SC, SI AND DB 2.1 Introduction The System Configuration, System Installation and Delegate Database Remote Interface is part of the DCN NG software which allows another controlling entity, not being the DCN NG Control PC, to use the System Configuration, System Installation and Database applications. 2.
DCN Next Generation Open Interface Release 2.4 Config Install and Database en | 41 Related functions The related function in conjunction with the function described. It refers to other remote functions and to related update notifications. 2.3 System Modes To understand the SC and SI functions, one should have some knowledge on the behavior of the CCU depending on the various so-called system modes. This section gives a brief, although complete, description of these modes.
DCN Next Generation Open Interface Release 2.4 Config Install and Database en | 42 3. SYSTEM CONFIGURATION (SC) FUNCTIONS 3.1 Introduction The system configuration functions described in this section are needed to query the set-up of the DCN NG-system from the CCU. The system configuration functions allow the remote controller to monitor any changes in the DCN NG system configuration. This chapter defines the set of remote functions for system configuration. 3.
DCN Next Generation Open Interface Release 2.4 Config Install and Database en | 43 Related functions SC_C_STOP_APP 3.4 SC_C_STOP_APP Purpose Indicates the CCU that the remote controller no longer requires updates from the SC application inside the CCU. After receiving this function the CCU decrements the update ‘use’ count. As long as the update use count is greater than zero, the CCU remains sending the update notifications to the remote controller.
DCN Next Generation Open Interface Release 2.4 Config Install and Database • • • • • szSwVersion en | 44 SC_C_EXTENDED SC_C_SINGLETRUNC SC_C_MULTITRUNC SC_C_MASTER SC_C_SLAVE The current operating mode of the CCU in readable text. The string is zero (‘\0’) terminated. If e.g. it is a Single CCU running extended software, this string would read: “EXTENDED SingleTrunc Version”.
DCN Next Generation Open Interface Release 2.4 Config Install and Database en | 45 Availability This function is available in CCU system mode congress. Do not use this function because this function becomes deprecated in next major release. Parameter structure for the function The parameter structure is the same as SC_C_GET_CCU_CONFIG_PROPERTY.
DCN Next Generation Open Interface Release 2.4 Config Install and Database typedef struct { WORD WORD WORD SC_T_UNIT_DATA_PROPERTY } SC_T_CCU_CONFIGURATION; wNumberOfSlaveCCUs; wNumberOfUnitsConnected; wNumberOfUnits; tUnitData [SC_C_CLUSTER_MAX]; where the SC_T_UNIT_DATA_PROPERTY is defined as: typedef struct { WORD wUnitId; BYTE byUnitType; WORD wUnitProperties } SC_T_UNIT_DATA_PROPERTY; where: wNumberOfSlaveCCUs The number of Slave-CCU’s connected within a Multi-CCU system, which ranges from 0 to 16.
DCN Next Generation Open Interface Release 2.4 Config Install and Database • • • en | 47 DCNC_UNIT_ENTRANCE DCNC_UNIT_EXIT DCNC_UNIT_AMBIENT_MIC Note that future unit extensions of the DCN NG system can lead to new unit-type, not presented in this list. Note that not all of these units are supported in the first releases of DCN NG (see 1.2). wUnitProperties Holds the properties of a unit. This can be a combination of the following.
DCN Next Generation Open Interface Release 2.4 Config Install and Database en | 48 3.9 SC_C_GET_SLAVE_NODES Purpose Retrieve the slave nodes of the unit. This will be only applicable when the unit runs in SI_C_OPERATION_MODE_MULTI. Availability This function is available in system mode: MAINTENANCE, CONFIG and CONGRESS.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.4 Config Install and Database 4. SYSTEM CONFIGURATION (SC) NOTIFICATIONS 4.1 Introduction This chapter defines the set of update notifications concerning SC send by the CCU. 4.1.1 Update Notification item explanation Each 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. 4.1.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.4 Config Install and Database Event Update Notification Continue with remote function and a few seconds later for every unit connected to that Slave CCU separately SC_C_CONNECT_UNIT the unit connect updates: SI_C_START_INSTALL and run installation as described in example-2 in Appendix C Switch On another Single-Mode CCU Switch Off a Slave CCU SC_C_DISCONNECT_SLAVE_CCU Switch Off another Single-Mode CCU Connect a unit to CCU-A.
DCN Next Generation Open Interface Release 2.4 Config Install and Database en | 53 4.4 SC_C_DISCONNECT_UNIT Purpose Notifies the remote controller that a unit has lost his connection with the CCU (i.e. the unit is disconnected from the ACN-trunk or MOST-trunk). This notification informs the remote controller that the unit is no longer available. Notify structure with this update The update comes along with the same structure as defined in section 4.3. 4.
DCN Next Generation Open Interface Release 2.4 Config Install and Database en | 54 Only this amount of array elements is transmitted. tDisconnectedUnits A list of units that are connected to the slave in question at the moment of disconnecting the slave. This means that all units reported in the list are also disconnected. Each list element is defined as a SC_T_UNIT_DATA structure which is defined in section 3.6.
DCN Next Generation Open Interface Release 2.4 Config Install and Database en | 55 5. SYSTEM INSTALLATION (SI) FUNCTIONS 5.1 Introduction The system installation functions provide functionality to connect unit identification with the seat numbers used within the congress-hall. This process is also called seat-assignment. This chapter defines the set of remote functions needed for system installation. Each description is according to the definition given in section 2.2.1. 5.
DCN Next Generation Open Interface Release 2.4 Config Install and Database en | 56 Update Notifications SC_C_CCU_MODE_CHANGE (if the remote controller is registered to receive SC update notifications, i.e. it has called SC_C_START_APP) Related functions SI_C_STOP_INSTALL SI_C_SELECT_UNIT 5.3 SI_C_STOP_INSTALL Purpose This function stops the installation started with the function SI_C_START_INSTALL. The CCU will return to congress mode if that is not the current system mode.
DCN Next Generation Open Interface Release 2.4 Config Install and Database en | 57 When called during the installation mode SI_C_GLOBAL_INSTALL_MODE the microphone of the unit will be turned on as long as the unit is selected. Availability This function is available in CCU system modes config and congress.
DCN Next Generation Open Interface Release 2.4 Config Install and Database en | 58 Sets the usage of the external present contact. The external present contact can be used to register present or used as a fraud contact. Availability This function is available in CCU system mode config. Parameter structure for the function SI_T_EXT_CONTACT byExtContact; where: byExtContact The usage of the external present contact which can be SI_C_NO_FUNCTION, SI_C_PRESENT or SI_C_FRAUD.
DCN Next Generation Open Interface Release 2.4 Config Install and Database en | 59 Parameter structure for the function WORD WORD wUnitId; wGain; where: wUnitId The unit identifier of a unit. Also called unit-number. wGain The microphone sensitivity/gain setting for the unit in the range 0..15. The values 0 up until 15 correspond with a microphone sensitivity setting change of -6dB up until 9dB in steps of 1 dB. The default value of the microphone sensitivity is DCNC_MICROPHONE_GAIN_DEFAULT.
DCN Next Generation Open Interface Release 2.4 Config Install and Database Availability This function is available in CCU system modes config, congress and maintenance. Parameter structure for the function The function has no input parameters. Response structure from the function The function has no response parameters. Error codes returned SI_E_NOERROR SI_E_NO_UNITS_FOUND 5.11 SI_C_REQ_OPERATION_MODE Purpose Request the operation mode of all units in the parameter list.
DCN Next Generation Open Interface Release 2.4 Config Install and Database Related functions SI_C_REQ_OPERATION_MODE Update notifications SI_C_OPERATION_MODE 5.13 SI_C_REQ_SLAVE_ID Purpose Request the slave identification of the unit. After executing this function, a notification will be send for each known unit. Availability This function is available in system mode: CONFIG. Parameter structure for the function This function requires the structure SI_T_SERIALNR_LIST as parameter.
DCN Next Generation Open Interface Release 2.4 Config Install and Database en | 62 6. SYSTEM INSTALLATION (SI) NOTIFICATIONS 6.1 Introduction This chapter defines the set of update notifications concerning SI send by the CCU. Each description is according to the definition given in section 4.1.1. 6.1.1 Unit/user event relations As for the SC application, update notifications for SI are also the results of user actions done on the actual units.
DCN Next Generation Open Interface Release 2.4 Config Install and Database en | 63 6.3 SI_C_OPERATION_MODE Purpose Notifies the remote controller the operation mode of the unit. This notification is send after the operation mode of the unit has been changed. Notify structure with this update The update comes with the structure SI_T_OPERATION_MODE as defined in section xxx. 6.4 SI_C_SLAVE_ID Purpose Notifies the remote controller the slave identification of the unit.
DCN Next Generation Open Interface Release 2.4 Config Install and Database en | 64 7. DELEGATE DATABASE (DB) FUNCTIONS 7.1 Introduction The system configuration functions allow users to compile a comprehensive database of information relating to participants at a conference or meeting. This chapter defines the set of remote functions for system configuration. 7.2 DB_C_START_APP Purpose Indicate the CCU that the remote controller wants to communicate with the delegate database in the CCU.
DCN Next Generation Open Interface Release 2.4 Config Install and Database Response structure from the function The function has no response parameters. Error codes returned DB_E_NOERROR DB_E_APP_NOT_STARTED DB_E_NOT_INCONTROL related functions DB_C_START_APP 7.4 DB_C_MAINT_CCU Purpose The delegate database in the CCU can be changed using this remote function. Availability This function is available in CCU system mode congress.
DCN Next Generation Open Interface Release 2.4 Config Install and Database en | 66 access control. lPin Delegate pin code. A numeric value in the range 111...555551. PIN codes or DB_C_NO_PIN are used for attendance registration and access control, but do not have to be unique. wUnitNr The unit number that the delegate is assigned to by default. This unit number must equal UnitId retrieved with SC_C_GET_CCU_CONFIG or equal to DCNC_UNASSIGNED_UNIT. byiDeskLang Delegate display language.
DCN Next Generation Open Interface Release 2.4 Config Install and Database 7.5 DB_C_DOWNLOAD_CCU Purpose The delegate database in the CCU can be filled using this remote function. Availability This function is available in CCU system mode congress. Parameter structure for the function The same structures are used as in the function DB_C_MAINT_CCU. Response structure from the function The function has no response parameters.
DCN Next Generation Open Interface Release 2.4 Config Install and Database 7.7 DB_C_CCU_APPLY_ONE Purpose With this function it is possible to add or update just one record in the delegate database in the CCU. Note that using this function you can only add or update a record of an existing database on the CCU. You cannot create a database using this function.
DCN Next Generation Open Interface Release 2.4 Config Install and Database APPENDIX A. VALUES OF THE DEFINES In this document a lot of definitions are given, which have values connected to them. In this appendix all defines will be connected to their values. The values are presented in ‘C’-syntax and are grouped on related purpose.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.4 Config Install and Database en | 72 APPENDIX B. ERROR CODES Responses returned upon a remote function request contain an error field (‘wError’). In this appendix an overview is given of the possible errors and their values. System Configuration Error code Explanation SC_E_NOERROR The execution of the remote function was successful. System Installation Error code Explanation SI_E_NOERROR The execution of the remote function was successful.
DCN Next Generation Open Interface Release 2.4 Config Install and Database Database Query Services Error code Explanation Setting a new size for the PIN Code into the Delegate Database failed. DB_E_DELEGATE_LIST_TOO_BIG en | 73 Value (hex.) 10402 (0x28A2) The wFillLevel parameter in DB_C_MAINT_CCU has a value larger then DB_C_MAX_N_DL_DEL_REC. 10403 DB_E_INSERT_DELEGATE_FAILED (0x28A3) Inserting the current DB_T_PERDELEGATE structure into the Delegate Database failed.
DCN Next Generation Open Interface Release 2.4 Config Install and Database Database Query Services Error code en | 74 Value (hex.) Explanation The control-type passed to the function DB_C_START_APP is not within range of valid values (see appendix 6.3 for the correct control-type values). 10415 DB_E_NOT_INCONTROL (0x28AF) The remote function is not allowed, because this remote controller has no control over the delegate database.
DCN Next Generation Open Interface Release 2.4 Config Install and Database en | 75 APPENDIX C. EXAMPLES In the examples 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.
DCN Next Generation Open Interface Release 2.4 Config Install and Database en | 76 Note that this function is only an example to shown how the interaction between update notifications and remote functions can appear. For instance, when you press a soft-key the second time, this function will fail. Better is to look if the selected unit has already a seat assigned. If not, the assign and increment, if assigned, just keep the assignment.
DCN Next Generation Open Interface Release 2.4 Config Install and Database } /* do error handling */ /* Let the operater determine which seat should be assigned to the selected unit. Normally the operator will view which unit is flashing, checks the seat-number and pass the seat-number found to the remote controller.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.4 Microphone Management en | 80 Table of Contents 1. Introduction ........................................................................................................................................... 82 1.1 Purpose....................................................................................................................................... 82 1.2 Scope.................................................................................................
DCN Next Generation Open Interface Release 2.4 Microphone Management en | 81 4.1.1 Update notification item explanation ........................................................................... 108 4.1.2 Unit/user event relations.............................................................................................. 108 4.2 MM General notifications .......................................................................................................... 110 4.2.1 MM_C_SET_MIC_OPER_MODE_ON_PC......
DCN Next Generation Open Interface Release 2.4 Microphone Management en | 82 1. INTRODUCTION 1.1 Purpose 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 Software Requirement Specification 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.
DCN Next Generation Open Interface Release 2.4 Microphone Management en | 83 Appendix B gives an overview of the possible error’s, which could be returned upon a remote function. Appendix C gives an example on using the remote interface for Microphone Management.
DCN Next Generation Open Interface Release 2.4 Microphone Management en | 84 2. MICROPHONE MANAGEMENT FOR A REMOTE INTERFACE 2.1 Introduction The Microphone Management Remote Interface is part of the DCNNG software, which allows for another controlling entity outside the CCU, not being the DCNNG 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.
DCN Next Generation Open Interface Release 2.4 Microphone Management en | 85 Microphone Management application has five microphone lists, which will be explained in the table below: List Notebook Explanation The notebook contains units having special privileges for turning on their microphone. This list always contains the Chairman units in the system. Other units can only be added to the notebook from within the MM application on a DCNNG Control PC. The notebook exists in all operation modes.
DCN Next Generation Open Interface Release 2.4 Microphone Management Mode OPERATOR WITH REQUEST LIST equals MM_C_OPERATOR_WITH_REQ_LIST DELEGATE WITH REQUEST LIST equals MM_C_DELEGATE_WITH_REQ_LIST DELEGATE WITH OVERRIDE equals MM_C_DELEGATE_WITH_OVERRIDE DELEGATE WITH VOICE ACTIVATION equals MM_C_DELEGATE_WITH_VOICE OPERATOR WITH REQUEST AND RESPONSE LIST equals MM_C_OPERATOR_WITH_COMMENT_LIS T DELEGATE WITH PUSH TO TALK en | 86 Mode description & Group enable/disable Manual mode.
DCN Next Generation Open Interface Release 2.4 Microphone Management Equals MM_C_DELEGATE_WITH_PUSHTOTALK en | 87 Whenever a delegate presses his micro-button, he is directly able to speak in case the SPK list is not full. • disables all RTS functions/notifications • enables all SPK functions/notifications • disables all CR functions/notifications • disables all CS functions/notifications The SPK functions and notifications mentioned in the table are described in respectively, sections 3.3 and 4.3.
DCN Next Generation Open Interface Release 2.4 Microphone Management en | 88 3. REMOTE FUNCTIONS 3.1 Introduction 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.
DCN Next Generation Open Interface Release 2.4 Microphone Management en | 89 Response structure from the function The function returns the following structure: WORD wNrOfInstances where: wNrOfInstances The value of the update use count for the MM application at the end of the function handling. It contains the number of times a remote PC has connected over the same communication medium. E.g. the first time the MM_C_START_MM function is called, it contains the value 1.
DCN Next Generation Open Interface Release 2.4 Microphone Management en | 90 Error codes returned MM_E_NOERROR MM_E_OPEN_CLOSE_FAILED Related functions MM_C_START_MM 3.2.3 MM_C_START_MON_MM Purpose Function to start the monitoring behavior of the Microphone Management application. It is not allowed/possible to control settings of Microphone Management. Parameter structure for the function The function has no additional parameters.
DCN Next Generation Open Interface Release 2.4 Microphone Management following: • • • • • • en | 91 MM_C_OPERATOR_WITH_REQ_LIST MM_C_DELEGATE_WITH_REQ_LIST MM_C_DELEGATE_WITH_OVERRIDE MM_C_DELEGATE_WITH_VOICE MM_C_OPERATOR_WITH_COMMENT_LIST MM_C_DELEGATE_WITH_PUSHTOTALK If the operation mode is set to MM_C_OPERATOR_WITH_COMMENT_LIST, the maximum number of active microphones will be set to 1 if not done by the operator. Response structure from the function The function has no response parameters.
DCN Next Generation Open Interface Release 2.4 Microphone Management en | 92 3.2.7 MM_C_GET_SETTINGS Purpose Retrieve the general settings from the MM-application. This function can be used to get the initial state of the operation mode and the number of active microphones as set using the button on the front panel of the CCU. Parameter structure for the function The function has no additional parameters.
DCN Next Generation Open Interface Release 2.4 Microphone Management en | 93 MM_C_ATTENTION_TONE1 or MM_C_ATTENTION_TONE2 or MM_C_ATTENTION_TONE3: An attention tone (tone 1, 2 or 3) is generated when the priority key is pressed on a chairman-unit. bAmbientMicCtrl TRUE: The ambient microphone control is enabled. Ambient mic. control means that the ambient mic.
DCN Next Generation Open Interface Release 2.4 Microphone Management en | 94 3.3.1 MM_C_SET_MICRO_ON_OFF Purpose Control the microphone of a unit. This function gives the ability to turn the microphone of a unit on or off. To describe the functionality included with this function several cases of this function are described in the table below: Case Action performed Delegate unit micro on The unit is appended to the SPK list if possible.
DCN Next Generation Open Interface Release 2.4 Microphone Management When the unit is already present in the SPK list, an error is reported and the current microphone status of the unit is unchanged. The CS list, if present, will be cleared. Parameter structure for the function The function requires the following structure as parameter: typedef struct { WORD wUnitId; } MM_T_SPK; where: wUnitId Unit Identifier Response structure from the function The function has no response parameters.
DCN Next Generation Open Interface Release 2.4 Microphone Management Response structure from the function The function has no response parameters. Error codes returned MM_E_NOERROR Update notifications MM_C_SPK_CLEAR_ON_PC Related functions MM_C_SPK_APPEND 3.3.5 MM_C_SPK_GET Purpose Retrieve the complete contents of the Speakers list as present in the CCU. Parameter structure for the function The function has no additional parameters.
DCN Next Generation Open Interface Release 2.4 Microphone Management en | 97 Parameter structure for the function This function requires the structure MM_T_SPK as parameter. This structure is defined in section 3.3.2. Response structure from the function The function has no response parameters. Error codes returned MM_E_NOERROR MM_E_ILLEGAL_MIC_OPER_MODE MM_E_UNIT_NOT_PRESENT MM_E_UNKNOWN_UNIT Update notifications MM_C_CS_REMOVE_ON_PC 3.4.
DCN Next Generation Open Interface Release 2.4 Microphone Management Related Functions MM_C_NBK_SET MM_C_NBK_GET 3.5.2 MM_C_NBK_CLEAR Purpose Clear the complete contents of the Notebook list Parameter structure for the function The function has no additional parameters. Response structure from the function The function has no response parameters. Error codes returned MM_E_NOERROR Update notifications MM_C_NBK_SET_ON_PC Related Functions MM_C_NBK_SET 3.5.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.4 Microphone Management • • • • • • en | 100 MM_C_VOICE_NO_AC MM_C_VCHAIR_NO_AC MM_C_VIP_PTTCHAIRMAN MM_C_VIP_PTT MM_C_VIP_PTTCHAIRMAN_NO_AC MM_C_VIP_PTT_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 DCNNG Control PC.
DCN Next Generation Open Interface Release 2.4 Microphone Management en | 101 3.6.1 MM_C_RTS_APPEND Purpose Add a delegate/unit combination to the RTS list on the CCU. Parameter structure for the function This function requires the structure MM_T_RTS as parameter. This structure is defined in section 3.6. Response structure from the function The function has no response parameters.
DCN Next Generation Open Interface Release 2.4 Microphone Management en | 102 Parameter structure for the function The function has no additional parameters. Response structure from the function The function has no response parameters. Error codes returned MM_E_NOERROR Update notifications MM_C_RTS_CLEAR_ON_PC MM_C_RTS_CLEAR_COMMENT_ON_PC Related functions MM_C_RTS_APPEND MM_C_RTS_REMOVE 3.6.4 MM_C_RTS_GET Purpose Retrieve the complete contents of the Request To Speak list as present in the CCU.
DCN Next Generation Open Interface Release 2.4 Microphone Management en | 103 MM_E_RTS_LIST_TOO_BIG MM_E_UNKNOWN_UNITID_AND_DELID MM_E_INSERT_RTS_LIST_FAILED MM_E_UNITID_DELID_MISMATCH MM_E_ILLEGAL_MICRO_TYPE Update notifications MM_C_RTS_SET_ON_PC Related functions MM_C_RTS_GET 3.6.6 MM_C_SHIFT Purpose Perform a shift function, i.e. promote a delegate from the RTS list to the Speakers list.
DCN Next Generation Open Interface Release 2.4 Microphone Management en | 104 MM_C_SPK_APPEND_ON_PC MM_C_RTS_FIRST_ON_PC 3.7 MM Comment Request list functions This section describes the functions to manipulate the CR list. The Comment Request list is a list of delegates with their unit identifications, which are waiting to get speech-time to respond to the current speaker. This comment request list is to prevent the delegate from being added at the end of the normal RTS list.
DCN Next Generation Open Interface Release 2.4 Microphone Management en | 105 Related functions MM_C_RTS_CLEAR_COMMENT 3.7.3 MM_C_SHIFT_CR Purpose Perform a shift function on the CR list, i.e. promote a delegate from the CR list to the CS list. The shift differs from other Comment Request list or Speakers list functions in such a way that the promoted delegate is always added to the comment speakers list, whether this list is full or not.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.4 Microphone Management 3.8.3 MM_C_TIME_FINISHED_WARNING Purpose This function is used to inform a particular unit that its time to speak is run out. Parameter structure for the function This function has one parameter: WORD wUnitId; where: wUnitId The unit on which to place the message. Response structure from the function This function has no response parameters.
DCN Next Generation Open Interface Release 2.4 Microphone Management en | 108 4. UPDATE NOTIFICATIONS 4.1 Introduction 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.
DCN Next Generation Open Interface Release 2.4 Microphone Management en | 109 UNIT-EVENT MATRIX Input event Operational Mode C: Chairman D: Delegate Delegate with Req.List Operator with Req.
DCN Next Generation Open Interface Release 2.4 Microphone Management en | 110 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-to-Speak-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).
DCN Next Generation Open Interface Release 2.4 Microphone Management en | 111 • MM_C_PC_MIC_NONE wPrioId Passes the prio-status of the chairman unit. This priority information indicates to the remote controller that the delegate units can be muted due to a priority key pressed on this chairman-unit. Although the microphone is turned on, the delegate can not yet speak.
DCN Next Generation Open Interface Release 2.4 Microphone Management en | 112 4.3.4 MM_C_SPK_CLEAR_ON_PC Purpose Notifies the remote controller that the SPK list is cleared. Notify structure with this update The update does not have any additional parameters. 4.3.5 MM_C_SPK_APPEND_ON_PC Purpose Notifies the remote controller that a unit is added to the SPK list.
DCN Next Generation Open Interface Release 2.4 Microphone Management en | 113 MM_T_SPK tNewSpk; } MM_T_SPK_REPLACE; where: tCurrSpk The SPK entry to search for. This SPK entry is replaced by the new value given in the parameter ‘tNewSpk’. tNewSpk The SPK entry holding the new contents. 4.4 MM Comment Speaker list notifications The Microphone Management comment speaker list notifications report the changes in the comment speakers list. 4.4.
DCN Next Generation Open Interface Release 2.4 Microphone Management en | 114 typedef struct { WORD wUnitId; WORD wMicroType; } MM_T_NBK; where: wUnitId Unit identifier wMicroType The type of microphone handling for the notebook entry as defined in 3.5.3 4.5.2 MM_C_NBK_SET_ON_PC purpose Notifies the remote controller that the CCU has a complete new notebook list. Note that all chairmen units will be included inside the notebook list.
DCN Next Generation Open Interface Release 2.4 Microphone Management en | 115 Notify structure with this update The update comes with the following structure: MM_T_RTS tRtsFirst; where: tRtsFirst The RTS list entry, which is now at the top of the RTS list. 4.6.5 MM_C_RTS_INSERT_ON_PC Purpose Notifies the remote controller that a delegate/unit combination is inserted in the RTS list before another RTS entry.
DCN Next Generation Open Interface Release 2.4 Microphone Management en | 116 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.
DCN Next Generation Open Interface Release 2.4 Microphone Management en | 117 APPENDIX A. VALUES OF THE DEFINES In this document a lot of definitions are given, which have values connected to them.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.4 Microphone Management 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. 2 MM_E_UNKNOWN_UNIT The UnitId is unknown in the CCU.
DCN Next Generation Open Interface Release 2.4 Microphone Management Microphone Management Error code Value Explanation length is not changed. To recover this error; clear the RTS list, set the new RTS list length and set the new contents in the RTS list. 26 MM_E_RTS_LIST_EMPTY The RTS list is empty; therefore the function cannot be fulfilled. E.g. 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.
DCN Next Generation Open Interface Release 2.4 Microphone Management en | 122 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.
DCN Next Generation Open Interface Release 2.4 Microphone Management { en | 123 tMMSettings.wActiveMics = 4); bMustSend = TRUE; } if (tMMSettings.wMaxRTSListLen != 50) { tMMSettings.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.4 Camera Control en | 126 Table of Contents 1. Introduction ......................................................................................................................................... 127 1.1 Purpose..................................................................................................................................... 127 1.2 Scope.........................................................................................................
DCN Next Generation Open Interface Release 2.4 Camera Control en | 127 1. INTRODUCTION 1.1 Purpose The purpose of this document is to describe the remote interface for Camera Control Interpretation between the CCU and third party software. 1.2 Scope This Software Requirement Specification describes the current state of the remote interface for Camera Control.
DCN Next Generation Open Interface Release 2.4 Camera Control en | 128 2. CAMERA CONTROL FOR A REMOTE INTERFACE 2.1 Introduction The Camera Control Remote Interface is part of the DCN Next Generation software that allows for another controlling entity outside the CCU, not being the DCN Next Generation Control PC, to use the Camera Control application. 2.2 Remote Camera Control Control Camera Control is the application that allows configuration of Automatic Camera Control.
DCN Next Generation Open Interface Release 2.4 Camera Control en | 129 3. REMOTE FUNCTIONS 3.1 Introduction This chapter describes the remote functions used to configure the Camera Control application on the CCU. 3.1.1 Remote function item explanation Each description consists of the following items: • Purpose A global description of the purpose of the function. • Parameter structure for the function The input parameters needed to fulfill the function.
DCN Next Generation Open Interface Release 2.4 Camera Control en | 130 Related functions CC_C_STOP_CAMERA_APP 3.2.2 CC_C_STOP_CAMERA_APP Purpose Indicate the CCU that the remote controller no longer requires to communicate with the CC application inside the CCU. After receiving this function the CCU takes over the control of CC. The remote controller will no longer receive update notifications. Parameter structure for the function The function has no additional parameters.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.4 Camera Control en | 132 cameras). This can be one of the following: • CC_C_NO_CAMERA_CONTROL_TYPE No equipment is used to control the cameras, i.e.
DCN Next Generation Open Interface Release 2.4 Camera Control en | 133 typedef struct { UNITID wUnitId; CC_T_CAMERA_ASSIGNMENT tCameraAssignment; } CC_T_INDEXED_CAMERA_ASSIGNMENT; where CC_T_CAMERA_ASSIGNMENT is defined as: typedef struct { WORD wCameraNumber; BYTE byPreposNumber; CHAR szSeatText_1[CC_C_MAX_SEAT_TEXT_LEN]; CHAR szSeatText_2[CC_C_MAX_SEAT_TEXT_LEN]; } CC_T_CAMERA_ASSIGNMENT; where: wLength The number of cameras for which an assignment is set in this structure.
DCN Next Generation Open Interface Release 2.4 Camera Control en | 134 CC_C_SET_GLOBAL_SETTINGS). This is a NULL terminated string. Response structure from the function The function has no response parameters. Error codes returned CC_E_NOERROR CC_E_NOT_INCONTROL CC_E_INVALID_UNITID CC_E_INVALID_CAMERA_NUMBER CC_E_INVALID_PARAMETER Related functions CC_C_SET_GLOBAL_SETTINGS CC_C_GET_GLOBAL_SETTINGS 3.2.7 CC_C_CLEAR_CAMERA_ASSIGNMENTS Purpose This function clears all camera assignments in the CCU.
DCN Next Generation Open Interface Release 2.4 Camera Control en | 135 returned. tIndexedCameraID Array holding the camera ID information. Only the first wLength items actually hold relevant information, the rest can be ignored. Each array element is defined as a CC_T_INDEXED_CAMERA_ID structure, which is defined below. wCameraNumber Identifier of the camera (as it is known on the connected equipment). This parameter can have value 1DBSC_MAX_CAMERA.
DCN Next Generation Open Interface Release 2.4 Camera Control Response structure from the function The function has no response parameters.
DCN Next Generation Open Interface Release 2.4 Camera Control 4. UPDATE NOTIFICATIONS 4.1 Introduction This chapter describes the various update notifications sent by the CCU. All the update notifications of the CC 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.
DCN Next Generation Open Interface Release 2.4 Camera Control en | 138 4.1.2 Unit/user event relations As mentioned in section 2.2, update notifications are not only the result of remote functions generated by the remote controller, but can also be the result of (interpreter) unit/user events. It was also mentioned in section 2.2 that the relation between the unit/user events and the update notifications is indirect (i.e. asynchronous).
DCN Next Generation Open Interface Release 2.4 Camera Control en | 139 4.2 CC General notifications 4.2.1 CC_C_RECEIVE_DATA Purpose This notification sends data received from the connected equipment to the remote controller. Notify structure with this update The update comes with the same structure as described in 3.2.10 (CC_T_DATA_FRAME).
DCN Next Generation Open Interface Release 2.4 Camera Control en | 140 APPENDIX A. VALUES OF THE DEFINES In this document a lot of defines are used, which have values connected to them.
DCN Next Generation Open Interface Release 2.4 Camera Control en | 141 APPENDIX B. ERROR CODES Responses returned upon a remote function request contain an error field (‘wError’). In this appendix an overview is given of the possible errors and their values. Camera Control Error code Value (hex.) Explanation 0 (0x00) CC_E_NOERROR The execution of the remote function was successful.
DCN Next Generation Open Interface Release 2.4 Camera Control en | 142 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.
DCN Next Generation Open Interface Release 2.4 Camera Control en | 143 Assume that we want to activate camera activity. We then need the following functions and control flow: CC_T_CAMERA_ACTIVITY tCameraActivity; tCameraActivity.bCameraActivity = TRUE; WORD wError; wError = CC_Set_Camera_Activity(&tCameraActivity); if (wError != CC_E_NOERROR) { /* do error handling */ } We can now send remote functions to configure camera control.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.4 Simultaneous Interpretation en | 146 Table of Contents 1. Introduction ......................................................................................................................................... 147 1.1 Purpose..................................................................................................................................... 147 1.2 Scope............................................................................................
DCN Next Generation Open Interface Release 2.4 Simultaneous Interpretation en | 147 1. INTRODUCTION 1.1 Purpose The purpose of this document is to describe the remote interface for Simultaneous Interpretation between the CCU and third party software. 1.2 Scope This Software Requirement Specification describes the current state of the remote interface for Simultaneous Interpretation.
DCN Next Generation Open Interface Release 2.4 Simultaneous Interpretation en | 148 2. SIMULTANEOUS INTERPRETATION FOR A REMOTE INTERFACE 2.1 Introduction The Simultaneous Interpretation Remote Interface is part of the DCN Next Generation software that allows for another controlling entity outside the CCU, not being the DCN Next Generation Control PC, to use the Simultaneous Interpretation application. 2.
DCN Next Generation Open Interface Release 2.4 Simultaneous Interpretation en | 149 3. REMOTE FUNCTIONS 3.1 Introduction This chapter describes the remote functions used to control the Simultaneous Interpretation application on the CCU. 3.1.1 Remote function item explanation Each description consists of the following items: • Purpose A global description of the purpose of the function. • Parameter structure for the function The input parameters needed to fulfill the function.
DCN Next Generation Open Interface Release 2.4 Simultaneous Interpretation en | 150 wDummy Dummy value, not used in the function. wPCActive The controller state. This controller state is a bit-shifted version (8-bit left shift) of one of the states IN_C_STANDALONE or IN_C_WITHPC. In case of IN_C_STANDALONE, the database system setting StandAloneIN is set to FALSE and the timer for controller update messages is deleted.
DCN Next Generation Open Interface Release 2.4 Simultaneous Interpretation en | 151 Error codes returned IN_E_NOERROR IN_E_INCONTROL_OTHER_CHANNEL IN_E_INCONTROL_THIS_CHANNEL Update notifications IN_C_CCU_CONFIG IN_C_CHAN_STATUS IN_C_LANGUAGE_LIST IN_C_FLASHING_MIC_ON IN_C_SPEAKSLOWLY_SIGN IN_C_HELP_SIGN Related functions IN_C_STOP_IN_APP 3.2.3 IN_C_STOP_IN_APP Purpose Indicate the CCU that the remote controller no longer requires to communicate with the IN application inside the CCU.
DCN Next Generation Open Interface Release 2.4 Simultaneous Interpretation wNrOfInstances en | 152 The value of the update use count for the IN application at the end of the function handling. It contains the number of times a remote controller has connected over the same communication medium. E.g. the first time the IN_C_START_MON_IN function is called, it contains the value 1. Note that calling IN_C_START_IN_APP also increases this update use count.
DCN Next Generation Open Interface Release 2.4 Simultaneous Interpretation struct { WORD WORD WORD DWORD }; en | 153 wBoothNr; wDeskNr; wAChannel; dwfBChannelSet; where: wBoothNr Booth number of the interpreter desk. Range: 1..31 wDeskNr Desk number of the interpreter desk. Range: 1..6 wAChannel The A out channel of the interpreter desk. Range: 1..
DCN Next Generation Open Interface Release 2.4 Simultaneous Interpretation en | 154 3.2.8 IN_C_UPDATE_LCK Remarks This function is exported in the IN remote interface for compatible reasons only! Use IN_C_UPDATE_LOCK instead. This function will not be supported from version 3.0. Purpose This function changes both lock modes and the engaged Led indication.
DCN Next Generation Open Interface Release 2.4 Simultaneous Interpretation en | 155 Parameter structure for the function The function requires the following structure as parameter: struct { BYTE BYTE BOOLEAN }; byWithin; byBetween; bNormalEngaged; where: byWithin Interlock mode within a booth, which can be one of the following values: • • • byBetween Interlock mode between booths, see byWithin for the possible values.
DCN Next Generation Open Interface Release 2.4 Simultaneous Interpretation BOOLEAN } IN_T_DB_DATA; en | 156 bNormalEngaged; where the IN_T_DESKCONFIG is defined as: typedef struct { BOOLEAN bInstalled; UNITID wUnitId; BYTE byIncoming; BYTE byOutgoing; CHAR cOutSelect; DWORD dwfBChannelSet; } IN_T_DESKCONFIG; in which a UNITID is defined as: typedef WORD UNITID; where: dwfAutoSet Autorelay flag. The bits of this DWORD indicate which booths are autorelay booths.
DCN Next Generation Open Interface Release 2.4 Simultaneous Interpretation en | 157 no unit assigned to the desk and booth number this identifier belongs to (see tDeskConf explanation), it must have the value DCNC_UNASSIGNED_UNIT. The mapping of unit identifiers to booth and desk numbers must be the same as the mapping received in the last IN_C_CHAN_STATUS notification (see 4.2.1 tIntMics). If this is not the case, the error IN_E_INCORRECT_DESK_CONFIG will be returned.
DCN Next Generation Open Interface Release 2.4 Simultaneous Interpretation en | 158 special value are ignored (this way the number of channels is determined). The range of the channel languages is 1..DBSC_MAX_LANGNAME. Also note that the range of the number of channels is 1..DBSC_MAX_INTERPRT_CHANNELS. Therefore if the constant IN_C_NOMORE_CHANNELS is found in tChannelLang[0] (implying the number of channels is equal to 0), the error code IN_E_WRONG_PARAMETER will be returned.
DCN Next Generation Open Interface Release 2.4 Simultaneous Interpretation en | 159 IN_C_FR_LANG_LIST_ID, else it is discarded. wAudioLangId The Identifier of the audio language. This parameter is ignored, the actual identifier is derived from the array index of tLangList by adding 1 to this index. E.g. the identifier of the audio language in tLangList[2] is 3. szLangName Name of the audio language. This must be a null terminated string (i.e.
DCN Next Generation Open Interface Release 2.4 Simultaneous Interpretation en | 160 where: bFloorDistribution TRUE if the floor signal must be distributed on the outgoing channel when no interpretation is performed FALSE if no signal must be distributed on the outgoing channel when no interpretation is performed. Response structure from the function The function has no response parameters.
DCN Next Generation Open Interface Release 2.4 Simultaneous Interpretation en | 161 Error codes returned IN_E_NOERROR IN_E_APP_NOT_STARTED Update notifications IN_C_SPEAKSLOWLY_SIGN Related functions IN_C_GET_SPEAKSLOWLY_SIGN 3.2.17 IN_C_GET_SPEAKSLOWLY_SIGN Purpose This function is used to retrieve the interpreter desks configuration concerning the enabling of speak slowly signaling. There are two possibilities: either the function is disabled or enabled.
DCN Next Generation Open Interface Release 2.4 Simultaneous Interpretation en | 162 3.2.19 IN_C_GET_HELP_SIGN Purpose This function is used to retrieve the interpreter desks configuration concerning the enabling of help signaling. There are two possibilities: either the function is disabled or enabled. Parameter structure for the function The function has no additional parameters.
DCN Next Generation Open Interface Release 2.4 Simultaneous Interpretation 4. UPDATE NOTIFICATIONS 4.1 Introduction This chapter describes the various update notifications sent by the CCU. All the update notifications of the IN 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.
DCN Next Generation Open Interface Release 2.4 Simultaneous Interpretation 1 2 3 4 en | 164 4.1.2 Unit/user event relations As we have mentioned in section 2.2, update notifications are not only the result of remote functions generated by the remote controller, but can also be the result of (interpreter) unit/user events. It was also mentioned in section 2.2 that the relation between the unit/user events and the update notifications is indirect (i.e. asynchronous).
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.4 Simultaneous Interpretation 1 4.2 IN General notifications 2 3 4 4.2.1 IN_C_CHAN_STATUS en | 166 Purpose Notifies the remote controller of a status update.
DCN Next Generation Open Interface Release 2.4 Simultaneous Interpretation en | 167 1 2 3 4 4.2.2 IN_C_CCU_CONFIG Purpose Notifies the remote controller of a configuration update.
DCN Next Generation Open Interface Release 2.4 Simultaneous Interpretation 1 2 3 4.2.3 IN_C_FLASHING_MIC_ON Purpose Notifies the remote controller of the flashing microphone button ring setting. 4 5 6 Notify structure with this update The update comes with the following structure: 7 where: BOOLEAN bFlashingWhenEngaged bFlashingWhenEngaged 8 9 10 TRUE if the microphone button ring flashes when engaged FALSE if the microphone button ring does not flash when engaged. 4.2.
DCN Next Generation Open Interface Release 2.4 Simultaneous Interpretation tLangList 1 2 3 Array holding the actual language list information. Each array element is defined as an IN_T_LANGLIST structure that is defined below. If the version of the language list is IN_C_ENG_LANG_LIST_ID or IN_C_FR_LANG_LIST_ID, this array will be filled with dummy values (i.e. all language identifiers are 0 and all strings are empty).
DCN Next Generation Open Interface Release 2.4 Simultaneous Interpretation 1 en | 170 APPENDIX A. VALUES OF THE DEFINES 2 3 In this document a lot of defines are used, which have values connected to them.
DCN Next Generation Open Interface Release 2.4 Simultaneous Interpretation 1 2 3 en | 171 APPENDIX B. ERROR CODES Responses returned upon a remote function request contain an error field (‘wError’). In this appendix an overview is given of the possible errors and their values. 4 Simultaneous Interpretation Error code Explanation IN_E_NOERROR The execution of the remote function was successful. Value (hex.
DCN Next Generation Open Interface Release 2.4 Simultaneous Interpretation 1 en | 172 APPENDIX C. EXAMPLES 2 3 4 5 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.
DCN Next Generation Open Interface Release 2.4 Simultaneous Interpretation 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 en | 173 break; case IN_E_INCONTROL_OTHER_CHANNEL: /* Another remote controller has control over the IN application */ /* report error and terminate */ ........
DCN Next Generation Open Interface Release 2.4 Simultaneous Interpretation 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 en | 174 if (tCcuConfig.byBetweenLock != IN_C_OVERRIDE) { IN_T_UPDATE_LCK tUpdateLck; tUpdateLck.wWithin = (WORD)tCcuConfig.byWithinLock; tUpdateLck.byBetween = IN_C_OVERRIDE; tUpdateLck.bEngaged = TRUE; WORD wError; } wError = IN_Update_Lck(&tUpdateLck); if (wError != IN_E_NOERROR) { /* do error handling */ } else { /* update local administration */ tCcuConfig.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.4 Voting en | 176 Table of Contents 1. Introduction..........................................................................................................................................177 1.1 Purpose .....................................................................................................................................177 1.2 Scope .................................................................................................................
DCN Next Generation Open Interface Release 2.4 Voting en | 177 1. INTRODUCTION 1.1 Purpose The purpose of this document is to describe the SW interface for parliamentary voting between the DCN Next Generation system and third party software. 1.2 Scope This Software Requirements Specification describes the remote interface for parliamentary voting. It is meant for developers who want to use this SW interface to control the voting application, present in the DCN Next Generation system, remotely.
DCN Next Generation Open Interface Release 2.4 Voting en | 178 2. INTERNAL FUNCTIONING VOTING APPLICATION The voting application present in the CCU is set up as an engine capable of handling parliamentary kind of voting’s. For all voting rounds to be carried out, you can identify common aspects for each different kind of voting. The voting application uses the common aspects to control the voting requested. Some of these common aspects are: • Subject of the voting • The kind of the voting (e.g.
DCN Next Generation Open Interface Release 2.4 Voting en | 179 2.4.1 Result structure format definition As stated in the communication settings the results could be received normally or compressed. For both communication settings the same structure is used.
DCN Next Generation Open Interface Release 2.4 Voting Compressed en | 180 The ‘byDelegateVotes’ holds for each element (read byte) the vote-result of two (2) delegates. Using the compressed way of receiving results the structure can hold 2 * VT_C_MAX_RESULT_DELEGATE delegates, which is large enough to hold all delegates. However the vote-result is now stored in the upper or lower nibble of a byte.
DCN Next Generation Open Interface Release 2.4 Voting en | 181 bOpenVoting = FALSE; wInterimResultType = VT_C_INT_RES_NONE; More information about the parameters can be found in section 3.2.8.
DCN Next Generation Open Interface Release 2.4 Voting wPresentVotes VT_C_100_PRESENT_KEY VT_C_100_VALID_VOTES VT_C_100_PRESENT_KEY_AND_FRAUD VT_C_100_EXTERNAL_PRESENT bVoteWeightingOn FALSE en | 182 Note that when no delegate-database is present in the DCN Next Generation-system and other parameter settings are used, the remote function returns with the error-code VT_E_NO_NAMESFILE.
DCN Next Generation Open Interface Release 2.4 Voting en | 183 3. REMOTE FUNCTIONS 3.1 Introduction This chapter describes the various remote functions available to handle the voting application. A global description of the remote function handling is described in [SRS_INF]. [SRS_INF] also gives a description about the type used within this document. 3.1.1 Remote function item explanation Each description consists of the following items: • Purpose A global description of the purpose of the function.
DCN Next Generation Open Interface Release 2.4 Voting en | 184 collect the result using remote functions. bReserved Must be FALSE wViewTimeAfterStop The time in seconds that the “End of voting” text remains on the display of the delegate units. After this time the current main menu (e.g. Microphone menu) becomes active again. The value-range is 0-200 seconds. Response structure from the function The function has no response parameters.
DCN Next Generation Open Interface Release 2.4 Voting en | 185 Error codes returned VT_E_NOERROR VT_E_VOTE_RUNNING VT_E_APP_NOT_STARTED Update notifications VT_C_RESULTSNOTIFY Related functions VT_C_STOP_VOTING VT_C_HOLD_VOTING VT_C_RESTART_VOTING 3.2.4 VT_C_STOP_VOTING Purpose This function stops the running voting round.
DCN Next Generation Open Interface Release 2.4 Voting en | 186 Related functions VT_C_START_VOTING VT_C_STOP_VOTING VT_C_RESTART_VOTING 3.2.6 VT_C_RESTART_VOTING Purpose This function allows the remote controller to restart a voting round. Parameter structure for the function The function has no additional parameters. Response structure from the function The function has no response parameters.
DCN Next Generation Open Interface Release 2.4 Voting en | 187 Error codes returned VT_E_NOERROR VT_E_VOTE_RUNNING VT_E_APP_NOT_STARTED 3.2.8 VT_C_SET_VOTINGPARAMS Purpose This function allows the remote controller to set the kind of voting on the CCU for the next voting to be run. These settings can only be sent to the CCU when no voting is running.
DCN Next Generation Open Interface Release 2.4 Voting en | 188 the individual values of the parameter ‘wInterimResultType’ are invalid. wInterimResultType Identify if results will be sent during the vote round and how. If interim results are available then they will be sent regularly if the ‘bResultNotify’ parameter of the VT_C_START_APP remote function is set to TRUE.
DCN Next Generation Open Interface Release 2.4 Voting en | 189 3.2.9 VT_C_SET_GLOBAL_SETTINGS Purpose This function allows the remote controller to set the global voting settings on the CCU. No voting may be running during the call to this function.
DCN Next Generation Open Interface Release 2.4 Voting en | 190 Voted’ delegates are absolute. Valid values are: TRUE The voting is weighted. Each delegate uses its voteweight as set in the downloaded names-file (see [SRS_SCSIINF]). FALSE The voting is not weighted. Each delegate has the weight of 1 (one). bReserved3 Must be set to FALSE.
DCN Next Generation Open Interface Release 2.4 Voting en | 191 Only delegates that pressed both keys will count. All delegates have to activate the external present contact before actually casting a vote. Only delegates that activated the external present contact will count. VT_C_100_EXTERNAL_PRESENT Note that this functionality of ‘wPresentVotes’ depends on the use of the delegate database, the external contact and/or the attendance application, see [SRS_SCSIINF] and [SRS_ATINF] for more information.
DCN Next Generation Open Interface Release 2.4 Voting en | 192 Error codes returned VT_E_NOERROR VT_E_APP_NOT_STARTED Related functions VT_C_SET_ATTENTION_TONE VT_C_START_ATTENTION_TONE 3.2.12 VT_C_SET_ATTENTION_TONE Purpose This function allows the remote controller to set the configuration of the voting attention tone.
DCN Next Generation Open Interface Release 2.4 Voting en | 193 4. UPDATE NOTIFICATIONS 4.1 Introduction This chapter describes the various update notifications send by the CCU. All the update notifications of the VT application are listed in this chapter. A global description of notifications is described in [SRS_INF]. 4.1.1 Notification item explanation Each description consists of the following items: • Purpose A global description of the purpose of the notification.
DCN Next Generation Open Interface Release 2.4 Voting en | 194 Note also that if ‘bResultNotify’ is set to TRUE this notification is sent to the Remote Controller after a hold or stop of the voting round. Notify structure with this update The update comes with the structure VT_T_RESULT_REC. The structure is defined in section 2.4.1 Note that only the totals are sent to the remote controller.
DCN Next Generation Open Interface Release 2.4 Voting en | 195 APPENDIX A. VALUES OF THE DEFINES In this document a lot of definitions are given, which have values connected to them.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.4 Voting APPENDIX B. ERROR CODES Responses returned upon a remote function request contain an error field (‘wError’). In this appendix an overview is given of the possible errors and their values. Voting Error code Value Explanation 0 VT_E_NOERROR The execution of the remote function was successful. 276 VT_E_VOTE_RUNNING Indication that a vote round is running on this moment. 277 VT_E_VOTE_NOT_RUNNING No vote round running on this moment.
DCN Next Generation Open Interface Release 2.4 Voting en | 198 APPENDIX C. EXAMPLES In the examples below the remote functions are seen as functions, which can be called. The parameters passed to the function form the input parameter structure. When a function returns information, the parameter list is finished with a structure parameter to store the information into.
DCN Next Generation Open Interface Release 2.4 Voting en | 199 break; case VT_E_INCONTROL_OTHER_CHANNEL: /* Another remote controller has control over the voting application */ /* report error and terminate */ ......... break; case VT_E_NOERROR: /* function ended succesful, continue */ break; } default: /* some unexpected error occurred. */ /* report the error */ .........
DCN Next Generation Open Interface Release 2.4 Voting en | 200 For controlling the time mechanism and the interaction with the operator we use another two external functions. The first function returns TRUE when a second has passed and the second function returns TRUE when the operator has decided to stop the vote-round. Another external function is assumed to store the voting result. This function accepts the voting results as used for collecting the results from the CCU.
DCN Next Generation Open Interface Release 2.4 Voting en | 201 wError = VT_GetResults (&tResults); If (wError != VT_E_NOERROR) { /* do error handling */ } /* store the results */ MyFunction_StoreResults (&tResults); This completes the vote rounds, so we can start the next vote round to complete the voting session.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.4 Text Status Display en | 204 Table of Contents 1. Introduction ......................................................................................................................................... 205 1.1 Purpose..................................................................................................................................... 205 1.2 Scope....................................................................................................
DCN Next Generation Open Interface Release 2.4 Text Status Display en | 205 1. INTRODUCTION 1.1 Purpose The purpose of this document is to describe the remote interface for Text & Status Display between the CCU and third party software. 1.2 Scope This Software Requirement Specification describes the current state of the remote interface for Text & Status Display.
DCN Next Generation Open Interface Release 2.4 Text Status Display en | 206 2. TEXT & STATUS DISPLAY FOR A REMOTE INTERFACE 2.1 Introduction The Text & Status Display Remote Interface is part of the DCN Next Generation software that allows for another controlling entity outside the CCU, not being the DCN Next Generation Control PC, to use the Text & Status Display application. 2.
DCN Next Generation Open Interface Release 2.4 Text Status Display en | 207 3. REMOTE FUNCTIONS 3.1 Introduction This chapter describes the remote functions used to configure the Text & Status Display application on the CCU. 3.1.1 Remote function item explanation Each description consists of the following items: • Purpose A global description of the purpose of the function. • Parameter structure for the function The input parameters needed to fulfill the function.
DCN Next Generation Open Interface Release 2.4 Text Status Display en | 208 3.2.2 LD_C_STOP_LD_APP Purpose Indicate the CCU that the remote controller no longer requires to communicate with the LD application inside the CCU. After receiving this function the CCU takes over the control of LD. The remote controller will no longer receive update notifications. Parameter structure for the function The function has no additional parameters.
DCN Next Generation Open Interface Release 2.4 Text Status Display • LD_C_MM_FLAG_DISPLAY The MM application is enabled for the display • LD_C_MD_FLAG_DISPLAY The MD application is enabled for the display en | 209 wNrOfSpeakerLines Indicates how many lines of the display are used to show the speaker list. If this value is changed for an alphanumerical display, an update notification may be generated. This parameter may range from 0LD_C_MAX_NR_OF_DISPLAY_LINES.
DCN Next Generation Open Interface Release 2.4 Text Status Display The second display, which is an alphanumerical display • LD_C_DISPLAY_THREE The third display, which is an alphanumerical display • LD_C_DISPLAY_FOUR The fourth display, which is a graphical display The error LD_E_UNKNOWN_DISPLAY is returned if wDisplayId is not within the specified range. Response structure from the function The function has no response parameters.
DCN Next Generation Open Interface Release 2.4 Text Status Display 4. UPDATE NOTIFICATIONS 4.1 Introduction This chapter describes the various update notifications sent by the CCU. All the update notifications of the LD 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.
DCN Next Generation Open Interface Release 2.4 Text Status Display en | 212 4.1.2 Unit/user event relations As mentioned in section 2.2, update notifications may not only be the result of remote functions generated by the remote controller, but can also be the result of unit/user events. It was also mentioned in section 2.2 that the relation between the unit/user events and the update notifications is indirect (i.e. asynchronous).
DCN Next Generation Open Interface Release 2.4 Text Status Display en | 213 4.2 LD General notifications 4.2.1 LD_C_SEND_ANUM_DATA Purpose This notification sends the current (updated) contents of a display to the remote controller. Notify structure with this update The update comes with the following structure: typedef struct { WORD wDisplayId; CHAR szData[DCNC_MAX_DISPLAYDATA_SIZE]; WORD wNumOfChars; } LD_T_DISPLAY_DATA; where: wDisplayId Identifies the display for which the settings are sent.
DCN Next Generation Open Interface Release 2.4 Text Status Display en | 214 APPENDIX A. VALUES OF THE DEFINES In this document a lot of defines are used, which have values connected to them.
DCN Next Generation Open Interface Release 2.4 Text Status Display APPENDIX B. ERROR CODES Responses returned upon a remote function request contain an error field (‘wError’). In this appendix an overview is given of the possible errors and their values. Text & Status Display Error code Value (hex.) Explanation 0 (0x00) LD_E_NOERROR The execution of the remote function was successful.
DCN Next Generation Open Interface Release 2.4 Text Status Display en | 216 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.
DCN Next Generation Open Interface Release 2.4 Text Status Display void LD_SendAnumData(LD_T_DISPLAY_DATA* ptDisplayData) { /* Handle data of ptDisplayData */ } Assume that we want to store display settings of LD_C_DISPLAY_TWO. We then need the following functions and control flow: LD_T_DISPLAY_REC tSettings; tSettings.wDisplayId = LD_C_DISPLAY_TWO; /* Enable VT and MM application */ tSettings.wFlags = LD_C_VT_FLAG_DISPLAY | LD_C_MM_FLAG_DISPLAY; tSettings.wNrOfSpeakerLines = 4; tSettings.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.4 Message Distribution en | 220 Table of Contents 1. Introduction..........................................................................................................................................221 1.1 Purpose .....................................................................................................................................221 1.2 Scope ...................................................................................................
DCN Next Generation Open Interface Release 2.4 Message Distribution en | 221 1. INTRODUCTION 1.1 Purpose The purpose of this document is to describe the remote interface for Message Distribution between the CCU and third party software. 1.2 Scope This Software Requirement Specification describes the current state of the remote interface for Message Distribution.
DCN Next Generation Open Interface Release 2.4 Message Distribution en | 222 Appendix A gives an overview of the constants used in combination with the remote functions described in this document. Appendix B gives an overview of the possible errors which could be returned upon a remote function. Appendix C gives an example on using the remote interface for MD.
DCN Next Generation Open Interface Release 2.4 Message Distribution en | 223 2. MESSAGE DISTRIBUTION FOR A REMOTE INTERFACE 2.1 Introduction The Message Distribution 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 Message Distribution application. 2.2 Remote Message Distribution Control The Message Distribution application provides a means of generating and distributing text messages in a DCN environment.
DCN Next Generation Open Interface Release 2.4 Message Distribution en | 224 3. REMOTE FUNCTIONS 3.1 Introduction This chapter describes the various remote functions needed to use the Message Distribution functionality of the system. 3.1.1 Remote function item explanation Each description consists of the following items: • Purpose A global description of the purpose of the function. • Parameter structure for the function The input parameters needed to fulfil the function.
DCN Next Generation Open Interface Release 2.4 Message Distribution en | 225 3.2.2 MD_C_STOP_MON_MD Purpose Function to stop monitoring the behavior of the Message Distribution application. Update notifications will no longer be sent to the remote controller. Parameter structure for the function The function has no additional parameters.
DCN Next Generation Open Interface Release 2.4 Message Distribution en | 226 is ignored if wRcvType is not equal to MD_C_RCV_HALL.. wNumOfUnits The number of units present in wUnitList. wUnitList A list of unitIds that identifies which units should receive the message. Note that the units must be of type specified in wRcvType. If wRcvType has value MD_C_RCV_HALL, wUnitList and wNumOfUnits are ignored. Response structure from the function The function has no response parameters.
DCN Next Generation Open Interface Release 2.4 Message Distribution byLedMask en | 227 Bit mask identifying the state of the three delegate unit LEDs. The LEDs are defined as following: • MD_C_IN_NOTEBOOK_LED The notebook LED, a lighted amber LED-ring. • MD_C_MICRO_LED The microphone LED, a lighted red LED-ring • MD_C_RTS_LED The request to speak LED, a lighted green LED-ring. If the bit corresponding to a LED is present in the bit mask, the LED state must be ‘on’.
DCN Next Generation Open Interface Release 2.4 Message Distribution en | 228 4. UPDATE NOTIFICATIONS 4.1 Introduction This chapter describes the various update notifications sent by the CCU. All the update notifications of the MD 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.
DCN Next Generation Open Interface Release 2.4 Message Distribution byButtonType bOn en | 229 Identifies which button was pressed on the unit. This can be one of the following types: • MD_C_AUXILIARY_BUTTON The auxiliary button was pressed. This implies that the unit (identified by wUnitId) is a delegate unit. • MD_C_SPEAKSLOWLY_BUTTON The speak slowly button was pressed. This implies that the unit (identified by wUnitId) is an interpreter desk. • MD_C_HELP_BUTTON The help button was pressed.
DCN Next Generation Open Interface Release 2.4 Message Distribution en | 230 APPENDIX A. VALUES OF THE DEFINES In this document definitions are given, which have values connected to them.
DCN Next Generation Open Interface Release 2.4 Message Distribution en | 231 APPENDIX B. ERROR CODES Responses returned upon a remote function request contain an error field (‘wError’). In this appendix an overview is given of the possible errors and their values. Message Distribution Error code Value (hex.) Explanation 0 (0x00) MD_E_NOERROR The execution of the remote function was successful. 2576 (0xA10 MD_E_NO_MORE_MESSAGES_ALLOWED The maximum number of messages is reached (maximum is 10).
DCN Next Generation Open Interface Release 2.4 Message Distribution en | 232 APPENDIX C. EXAMPLES In the example below the remote functions, 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 or output structures described in the appropriate section.
DCN Next Generation Open Interface Release 2.4 Message Distribution en | 233 /* do error handling */ } else { switch (wNrOfInstances) { case 0: /* Something went wrong, handle error */ break; case 1: /* OK */ break; } } default: /* two or more, stop rest until we have one left */ WORD wNewNrOfInstances = 0; do { MD_StopMonMD(&wNewNrOfInstances); } while (wNewNrOfInstances > 1); break; Now we can receive update notifications. We need a function to receive the update.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.4 Attendance Registration en | 236 Table of Contents 1. Introduction..........................................................................................................................................237 1.1 Purpose .....................................................................................................................................237 1.2 Scope ................................................................................................
DCN Next Generation Open Interface Release 2.4 Attendance Registration en | 237 1. INTRODUCTION 1.1 Purpose The purpose of this document is to describe the remote interface for attendance registration between the CCU and third party software. 1.2 Scope This Software Requirements Specification describes the remote interface for attendance registration. It is meant for developers who want to use this remote interface to control the attendance registration application, present in the CCU, remotely.
DCN Next Generation Open Interface Release 2.4 Attendance Registration Appendix B gives an overview of the possible error’s that could be returned upon a remote function request. Appendix C gives some examples of remote functions.
DCN Next Generation Open Interface Release 2.4 Attendance Registration en | 239 2. INTERNAL FUNCTIONING OF ATTENDANCE REGISTRATION 2.1 Introduction The Attendance Registration application is divided into three closely related parts: a. Attendance registration b. Access control c. Delegate identification In the following section an explanation is given about the three parts.
DCN Next Generation Open Interface Release 2.4 Attendance Registration en | 240 The Access Control options are set in combination with the attendance registration options. 2.1.3 Delegate Identification This functionality provides information about what delegate is seating on which unit. Delegate Identification, i.e. location information, is available as a result of inserting ID Cards in and/or withdrawing them from units.
DCN Next Generation Open Interface Release 2.4 Attendance Registration en | 241 Authorization is a status identifying if a unit may be used or not by the delegate that currently resides on this unit. Note 2: When a delegate is marked 'Functioning', the application authorization stored in the delegate database controls whether access is allowed. 2.2.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.4 AT en | 245 In case that no delegate database is downloaded into the CCU settings for ID-card or PIN Code are not possible. There is simply no information about which delegate has which ID-card or PIN Code.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.4 AT en | 247 3. REMOTE FUNCTIONS 3.1 Introduction This chapter describes the various remote functions needed to control the attendance registration application inside the CCU. A global description of the remote function handling is described in [SRS_INF]. The CCU can operate in multiple modes. The use of the AT remote function is restricted to the “Congress Mode”. An overview of modes can be found in [SRS_SCSIINF]. 3.1.
DCN Next Generation Open Interface Release 2.4 AT en | 248 application. This full control implies the right to change the attendance registration settings. • AT_C_APP_MONITOR The remote controller only wants to monitor the presence changes. No control of the settings is allowed. Note that the second start of the application (without a stop) always results in an error. This implies that you cannot change from ‘control’ to ‘monitor’ mode by calling the AT_C_START_AT_APP again.
DCN Next Generation Open Interface Release 2.4 AT en | 249 where: bySeatAttend Identify on which type of unit attendance registration will take place. The setting is one of the following: • AT_C_SEAT • AT_C_ENTRANCE_EXIT bySeatAccess Identify if a delegate can only use his own assigned unit or also another unit. The setting is one of the following: • AT_C_ANY_SEAT • AT_C_ONE_SEAT byControlType Identify how attendance registration and/or access control will take place.
DCN Next Generation Open Interface Release 2.4 AT en | 250 Update notifications AT_C_SEND_INDIV_REGISTRATION AT_C_SEND_TOTAL_REGISTRATION Related Functions AT_C_STORE_SETTING AT_C_HANDLE_IDENTIFICATION 3.2.5 AT_C_HANDLE_IDENTIFICATION Purpose This function allows the remote controller to do the registration with his own equipment. After the local registration on the remote controller, he should pass the registered delegate to the DCN NG system.
DCN Next Generation Open Interface Release 2.4 AT en | 251 used. The number of digits to be used is also stored into the delegate database. (PIN-codes do not have to be unique.
DCN Next Generation Open Interface Release 2.4 AT en | 252 typedef struct { WORD wFillLevel; AT_T_DEL_ATTEND tDelegate[AT_C_MAX_DELEGATE]; } AT_T_REGISTER_INDIV; where the AT_T_DEL_ATTEND is defined as: typedef struct { WORD wUnitId; WORD wDelegateId; BYTE byAttend; } AT_T_DEL_ATTEND; where: wFillLevel Number of delegates in tDelegate (maximum of AT_C_MAX_DELEGATE) If wFillLevel is less than AT_C_MAX_DELEGATE, then the last cluster with delegate registration information is returned.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.4 AT en | 254 4. UPDATE NOTIFICATIONS 4.1 Introduction This chapter describes the various update notifications send by the CCU. All the update notifications of the AT application are listed in this chapter. A global description of notifications is made in [SRS_INF]. 4.1.1 Preconditions The update notifications coming from the AT application use the UnitId and DelegateId to connect each other.
DCN Next Generation Open Interface Release 2.4 AT en | 255 where: wAttend Number of delegates who have registered themselves present. wLeave Number of delegates who are known in the delegate database and who are not registered yet.
DCN Next Generation Open Interface Release 2.4 AT en | 256 APPENDIX A. VALUES OF THE DEFINES In this document a lot of definitions are given, which have values connected to them.
DCN Next Generation Open Interface Release 2.4 AT en | 257 APPENDIX B. ERROR CODES Responses returned upon a remote function request contain an error field (‘wError’). In this appendix an overview is given of the possible errors and their values. Attendance Registration Error code Value: Explanation AT_E_NOERROR The execution of the remote function was successful. AT_E_APP_NOT_STARTED The remote controller has not called the AT_C_START_AT_APP yet.
DCN Next Generation Open Interface Release 2.4 AT Attendance Registration Error code Explanation size.
DCN Next Generation Open Interface Release 2.4 AT en | 259 APPENDIX C. EXAMPLES In the examples 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.
DCN Next Generation Open Interface Release 2.4 AT en | 260 We now have control over the attendance registration application and may change the settings, but first the input parameter structure must be filled in: AT_T_SETTINGS tSettings; tSettings.bySeatAttend tSettings.bySeatAccess tSettings.
DCN Next Generation Open Interface Release 2.4 AT AT_T_ACTIVATE tActivate; tActivate.bAttendanceOn = FALSE; tActivate.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.4 Intercom en | 264 Table of Contents 1. Introduction..........................................................................................................................................265 1.1 Purpose .....................................................................................................................................265 1.2 Scope ...............................................................................................................
DCN Next Generation Open Interface Release 2.4 Intercom en | 265 1. INTRODUCTION 1.1 Purpose The purpose of this document is to describe the remote interface for Intercom between the CCU and third party software. 1.2 Scope This Software Requirement Specification describes the remote interface for Intercom. It is meant for developers who want to use this remote interface to control the Intercom application, present in the CCU, remotely. The Interface can be used to build an Intercom User interface.
DCN Next Generation Open Interface Release 2.4 Intercom en | 266 2. INTERCOM FOR A REMOTE INTERFACE 2.1 Introduction The Intercom Remote Interface is part of the DCN NG software, which allows for another controlling entity outside the CCU, not being the DCN NG Control PC, to use the Intercom application. 2.2 Remote Intercom Control Intercom is the application that allows for controlling intercom calls between delegates, chairmen and interpreters during a conference.
DCN Next Generation Open Interface Release 2.4 Intercom en | 267 3. REMOTE FUNCTIONS 3.1 Introduction This chapter describes the various remote functions needed to use the intercom functionality of the system. 3.1.1 Remote function item explanation Each description consists of the following items: • Purpose A global description of the purpose of the function. • Parameter structure for the function The input parameters needed to fulfil the function.
DCN Next Generation Open Interface Release 2.4 Intercom en | 268 Related functions IC_C_CLOSE_IC_APP 3.2.2 IC_C_CLOSE_IC_APP Purpose Indicates the CCU that the remote controller no longer requires updates from the IC application inside the CCU. Parameter structure for the function The function has no additional parameters. Response structure from the function The function has no response parameters. Error codes returned IC_E_NOERROR Related functions IC_C_START_IC_APP 3.2.
DCN Next Generation Open Interface Release 2.4 Intercom en | 269 4. UPDATE NOTIFICATIONS 4.1 Introduction This chapter describes the various update notifications sent by the CCU. All the update notifications of the IC 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.
DCN Next Generation Open Interface Release 2.4 Intercom en | 270 4.2.2 IC_UPD_OPERATOR_STATE Purpose Notifies the remote controller about the state of the operator. Notify structure with this update The update comes with the following structure: BYTE byState; where: byState The state of the operator This can be one of the following values: • IC_C_NOT_PRESENT • IC_C_IDLE • IC_C_NO_OPER • IC_C_CONNECTED • IC_C_CONN_BREAK • IC_C_NO_REQ • IC_C_RECEIVING • IC_C_DIALING • IC_C_RETURN 4.2.
DCN Next Generation Open Interface Release 2.4 Intercom wUnitId Unit Identifier of the unit initiating the call.
DCN Next Generation Open Interface Release 2.4 Intercom en | 272 APPENDIX A. VALUES OF THE DEFINES In this document a lot of definitions are given, which have values connected to them.
DCN Next Generation Open Interface Release 2.4 Intercom en | 273 APPENDIX B. ERROR CODES Responses returned upon a remote function request contain an error field (‘wError’). In this appendix an overview is given of the possible errors and their values. Intercom Error code Explanation IC_E_NOERROR The execution of the remote function was successful. IC_E_NO_AUDIO_CHANNELS There are no audio channels available for intercom. IC_E_NO_OPERATOR There is no operator assigned.
DCN Next Generation Open Interface Release 2.4 Intercom en | 274 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.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.4 Appendix DCN Wireless en | 276 Table of Contents 1. Introduction..........................................................................................................................................277 1.1 Purpose.....................................................................................................................................277 1.2 Scope ...................................................................................................
DCN Next Generation Open Interface Release 2.4 Appendix DCN Wireless en | 277 1. INTRODUCTION 1.1 Purpose The purpose of this document is to define the user interface of the Remote Interface Description. 1.2 Scope This document describes the user interface for the Remote Interface Description. It is not a functional specification of all aspects of the Remote Interface Description. Only the changed or added functionality comparing with the DCN NG remote interface description has been described.
DCN Next Generation Open Interface Release 2.4 Appendix DCN Wireless en | 278 2. GENERAL REMOTE DESCRIPTION General remote description information can be found in [SRS_INF]. 2.1 Remote function handling Remote requests will give a response with one or more notifications. All notifications, expected after executing the remote request, will be sent to the remote controller within 5 seconds.
DCN Next Generation Open Interface Release 2.4 Appendix DCN Wireless 3. SYSTEM CONFIGURATION (SC) FUNCTIONS All SC Function information can be found in [SRS_ SCSIINF]. 3.
DCN Next Generation Open Interface Release 2.4 Appendix DCN Wireless en | 280 wNumberOfSlaveCCUs See [SRS_SCSIINF] wNumberOfUnitsConnected See [SRS_SCSIINF] wNumberOfUnits See [SRS_SCSIINF] tUnitData [] See [SRS_SCSIINF] wUnitId See [SRS_SCSIINF] byUnitType DCNC_UNIT_WAP DCNC_UNIT_WDISC_DELEGATE DCNC_UNIT_WDISC_DELEGATE_NO_KEYS DCNC_UNIT_WDISC_DELEGATE_DUAL DCNC_UNIT_WDISC_CHAIRMAN DCNC_UNIT_WDISC_CHAIRMAN_NO_KEYS 3.
DCN Next Generation Open Interface Release 2.4 Appendix DCN Wireless en | 281 Response structure from the function The function has no response parameters. Error codes returned SC_E_NOERROR Update notifications SC_C_BATTERY_SERIAL SC_C_BATTERY_ COND 3.5 SC_C_SIGNAL_STATUS_REQ Purpose This function will request the signal status of all units in the parameter list. After executing this function a notification will be send for each known unit.
DCN Next Generation Open Interface Release 2.
DCN Next Generation Open Interface Release 2.4 Appendix DCN Wireless en | 283 4. SYSTEM CONFIGURATION (SC) NOTIFICATIONS 4.1 Introduction See [SRS_SCSIINF]. 4.1.1 Unit/user event relations UNIT-EVENT MATRIX Event Update Notification Connect a WAP SC_C_CONNECT_UNIT Disconnect a WAP SC_C_DISCONNECT_UNIT SC_C_DISCONNECT_UNIT ->For each unit connected to the WAP 4.2 SC_C_BATTERY_STATUS Purpose Notifies the remote controller the battery status of a unit.
DCN Next Generation Open Interface Release 2.4 Appendix DCN Wireless en | 284 When the unit has no battery the serial number will be 0xFFFFFFFF 4.4 SC_C_BATTERY_INFO_COND Purpose Notifies the remote controller the condition of the battery located in the unit. This notification is send after SC_C_BATTERY_INFO_REQ is executed.
DCN Next Generation Open Interface Release 2.4 Appendix DCN Wireless en | 285 4.7 SC_C_HW_VERSIONINFO Purpose Notifies the remote controller the hardware version information of a unit. This notification is send after SC_C_VERSIONINFO_REQ is executed, or when a slave unit is connected.
DCN Next Generation Open Interface Release 2.4 Appendix DCN Wireless 5. SYSTEM INSTALLATION (SI) FUNCTIONS All SI Function information can be found in [SRS_ SCSIINF]. 5.1 SI_C_GET_WAP_SETTINGS Purpose Retrieve all settings of the WAP. Availability This function is available in system mode: MAINTENANCE, CONFIG and CONGRESS. Parameter structure for the function The function has one parameter: UNITID tUnitId; where: tUnitId Reserved. (The unit identifier of a WAP.) Must be DCNC_UNASSIGNED_UNIT.
DCN Next Generation Open Interface Release 2.4 Appendix DCN Wireless en | 287 Error codes returned SI_E_NOERROR SI_E_WRONG_PARAMETER Related functions SI_C_GET_WAP_SETTINGS Update notifications SI_C_WAP_SETTINGS 5.3 SI_C_GET_WIRELESS_SETTINGS Purpose Retrieve all wireless system settings of the system. Availability This function is available in system mode: MAINTENANCE, CONFIG and CONGRESS. Parameter structure for the function The function has no additional parameters.
DCN Next Generation Open Interface Release 2.4 Appendix DCN Wireless en | 288 Availability This function is available in system mode: CONGRESS. Parameter structure for the function The function has no additional parameters.
DCN Next Generation Open Interface Release 2.4 Appendix DCN Wireless en | 289 medium. Error codes returned SI_E_NOERROR SI_E_REGISTER_RFS_FAILED Related functions SI_C_STOP_MON_SI 5.8 SI_C_STOP_MON_SI Purpose Function to stop monitoring the behavior of the SI application. Availability This function is available in system mode: MAINTENANCE, CONFIG and CONGRESS. Parameter structure for the function The function has no additional parameters.
DCN Next Generation Open Interface Release 2.4 Appendix DCN Wireless en | 290 6. SYSTEM INSTALLATION (SI) NOTIFICATIONS All SI Notifications information can be found in [SRS_ SCSIINF]. Notifications will only come while monitoring the SI application. 6.1 SI_C_WAP_SETTINGS Purpose Notifies the remote controller the settings of WAP. This notification is send after the settings of a WAP has been changed.
DCN Next Generation Open Interface Release 2.4 Appendix DCN Wireless 7. MICROPHONE MANAGEMENT (MM) FUNCTIONS All MM Function information can be found in [SRS_MMINF]. 7.
DCN Next Generation Open Interface Release 2.4 Appendix DCN Wireless en | 292 8. MICROPHONE MANAGEMENT (MM) NOTIFICATIONS All MM Notifications information can be found in [SRS_MMINF]. 8.1 MM_C_SET_SETTINGS_ON_PC Notify structure with this update The update comes with the structure MM_T_CCU_GLOBAL_SETTINGS as defined in section 7.1.
DCN Next Generation Open Interface Release 2.4 Appendix DCN Wireless en | 293 APPENDIX A. VALUES OF THE DEFINES FOR SC In this document a lot of definitions are given, which have values connected to them.
DCN Next Generation Open Interface Release 2.4 Appendix DCN Wireless en | 294 APPENDIX B. VALUES OF THE DEFINES FOR SI In this document a lot of definitions are given, which have values connected to them.
DCN Next Generation Open Interface Release 2.
© 2007 Bosch Communications Systems Data subject to change without notice 2007 February