--- title: "Blustream AMF41W" canonical: "https://docs.cuesystem.com/space/CVCDD/741179402/Blustream%20AMF41W" format: markdown ---
Table of content > Macro (toc)
> ⚠️ This driver contains only the basic control functions as provided by the AMF41W. The functions have only been verified in terminal mode due to time constraints. The driver could not be tested directly with a physical device. # Resources # Connecting the driver The driver has a single TCP client connector. This connector must be connected to any TCP client channel of the controller in the configuration. # Properties | | | | | | --- | --- | --- | --- | | Property name | Data type | Default value | Description | | Ip Address | Text | | To be filled according to the ip address of the controlled device. | | Telnet Port | Long | 23 | To be filled according to the telnet port of the controlled device. | | Connect Timeout | | 3 sec | The maximum time required to connect to the device. The default is 3 seconds, which is sufficient under normal circumstances with a margin. | | Answer Timeout | | 0.5 sec | The maximum time the device takes to respond to a command. The default is 0.5 seconds, which is normally sufficient with a margin. | # Errors Functions can set errors if they return false. These errors can be tested using the GetLastError() function. | **Error number** | **Error name** | **Description** | | --- | --- | --- | | 200001 | Send buffer too short | The formated command line is longer than 4000 characters. That complex command can not be send. | | 200002 | Receive buffer too short | The answer didn't fit into the receive buffer. | | 200003 | Connection failed | The Tcp Connect command to the AMF device failed. Maybe wrong IP address or device is not alive. | | 200004 | Send failed | The command data can not be send. Maybe the AMF device is disconnected now. | | 200005 | Receive timeout | Data not received in the timeout set. You can increase the value of the property *Answer Timeout* | | 200006 | Receive but not connected | The AMF device is not connected. The command was send, but the AMF device was disconnected. | | 200007 | No success answer | The AMF device does not respond with “[SUCCESS]“ phrase. | # Functions The device has several groups of functions, which corresponds to the breakdown of the driver functions. These groups are as follows. - *config* - *control* - *layout* - *scene* - *status* All of the following functions are encapsulations of the AMF41W telnet control commands. The parameter of all commands is a bytestring (ascii string). The parameter syntax is consistent with the Blustream corporate documentation for the AMF41W. The function names follow their image in the AMF41W documentation. For example, the ConfigOutputResolution function corresponds to the AMF41W telnet command config --output-resolution and the parameters correspond to the command description in the [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. ## Config functions ### ConfigOutputResolution This function sets the resolution of the output channel. See [AMF41W ](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2)documentation: ***config --output-resolution***. #### Syntax ```visualbasic Function ConfigOutputResolution(param As ByteString) As Boolean ``` #### Parameters param [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) It is the param string compatible with ***config --output-resolution*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. #### Return value [Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958#Boolean) True on success or False if an error occurs. The function GetLastError returns the error number.  #### Error numbers See **[Errors](https://cue.atlassian.net/wiki/spaces/CVCDD/pages/741179402/Blustream+AMF41W#Errors)** chapter. ### ConfigAutoSwitchSource #### Syntax ```visualbasic Function ConfigAutoSwitchSource(param As ByteString) As Boolean ``` This function enables or disables automatic display on the output channel. See [AMF41W ](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2)documentation: ***config --auto-switch-source***. #### Parameters param [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) It is the param string compatible with ***config --auto-switch-source*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. #### Return value [Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958#Boolean) True on success or False if an error occurs. The function GetLastError returns the error number.  #### Error numbers See **[Errors](https://cue.atlassian.net/wiki/spaces/CVCDD/pages/741179402/Blustream+AMF41W#Errors)** chapter. ### ConfigSourceSelect ### Syntax ```visualbasic Function ConfigSourceSelect(param As ByteString) As Boolean ``` This function sets the source to be displayed on the output channel or the target window if a multi-window layout is set. See [AMF41W ](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2)documentation:***config --source-select***. #### Parameters param [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) It is the param string compatible with ***config --source-select.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. #### Return value [Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958#Boolean) True on success or False if an error occurs. The function GetLastError returns the error number.  #### Error numbers See **[Errors](https://cue.atlassian.net/wiki/spaces/CVCDD/pages/741179402/Blustream+AMF41W#Errors)** chapter. ### ConfigMediaSourceAlias #### Syntax ```visualbasic Function ConfigMediaSourceAlias(param As ByteString) As Boolean ``` This function sets the alias name for the signal source. The alias can then be used as a reference to the input channel. See [AMF41W ](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2)documentation:***config --media-source alias***. #### Parameters param [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) It is the param string compatible with ***config --media-source alias.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. #### Return value [Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958#Boolean) True on success or False if an error occurs. The function GetLastError returns the error number.  #### Error numbers See **[Errors](https://cue.atlassian.net/wiki/spaces/CVCDD/pages/741179402/Blustream+AMF41W#Errors)** chapter. ### ConfigMediaSourceList The function gets a list of alias signal sources. See [AMF41W ](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2)documentation:***config --media-source list***. #### Syntax ```visualbasic Function ConfigMediaSourceList(ByRef result As ByteString) As Boolean ``` #### Parameters result [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) ByRef result value string compatible with ***config --media-source list.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. #### Return value [Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958#Boolean) True on success or False if an error occurs. The function GetLastError returns the error number.  #### Error numbers See **[Errors](https://cue.atlassian.net/wiki/spaces/CVCDD/pages/741179402/Blustream+AMF41W#Errors)** chapter. ### ConfigMediaSourceDel This function removes the alias name for the signal source. See [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation:***config --media-source del***. #### Syntax ```visualbasic Function ConfigMediaSourceDel(param As ByteString) As Boolean ``` #### Parameters param [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) param string compatible with ***config --media-source del.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. #### Return value [Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958#Boolean) True on success or False if an error occurs. The function GetLastError returns the error number.  #### Error numbers See **[Errors](https://cue.atlassian.net/wiki/spaces/CVCDD/pages/741179402/Blustream+AMF41W#Errors)** chapter. ### ConfigInputState The function returns the state of the signal source in the return variable result. See [AMF41W ](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2)documentation:***config --input-state.*** #### Syntax ```visualbasic Function ConfigInputState(param As ByteString, ByRef result As ByteString) As Boolean ``` #### Parameters param [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) param - string compatible with ***config --input-state.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) ByRef result - result string compatible with ***config --input-state.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. #### Return value [Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958#Boolean) True on success or False if an error occurs. The function GetLastError returns the error number.  #### Error numbers See **[Errors](https://cue.atlassian.net/wiki/spaces/CVCDD/pages/741179402/Blustream+AMF41W#Errors)** chapter. ### ConfigAudioSelect This function selects the audio signal source for the output channel. See [AMF41W ](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2)documentation:***config --audio-select.*** #### Syntax ```visualbasic Function ConfigAudioSelect(param As ByteString) As Boolean ``` #### Parameters param [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) param - string compatible with ***config --audio-select.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. #### Return value [Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958#Boolean) True on success or False if an error occurs. The function GetLastError returns the error number.  #### Error numbers See **[Errors](https://cue.atlassian.net/wiki/spaces/CVCDD/pages/741179402/Blustream+AMF41W#Errors)** chapter. ### ConfigAccessCode The function sets the passcode for the BYOD signal sources. See [AMF41W ](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2)documentation:***config --access-code.*** #### Syntax ```visualbasic Function ConfigAccessCode(param As ByteString) As Boolean ``` #### Parameters param [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) param - string compatible with ***config --access-code.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. #### Return value [Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958#Boolean) True on success or False if an error occurs. The function GetLastError returns the error number.  #### Error numbers See **[Errors](https://cue.atlassian.net/wiki/spaces/CVCDD/pages/741179402/Blustream+AMF41W#Errors)** chapter. ### ConfigByodEnable This function enables/disables access of BYOD signal sources. See [AMF41W ](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2)documentation:***config --byod-enable.*** #### Syntax ```visualbasic Function ConfigByodEnable(param As ByteString) As Boolean ``` #### Parameters param [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) param - string compatible with ***config --byod-enable.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. #### Return value [Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958#Boolean) True on success or False if an error occurs. The function GetLastError returns the error number.  #### Error numbers See **[Errors](https://cue.atlassian.net/wiki/spaces/CVCDD/pages/741179402/Blustream+AMF41W#Errors)** chapter. ## Control functions ### ControlReboot This function restarts the device. See [AMF41W ](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2)documentation:***control --reboot.*** #### Syntax ```visualbasic Function ConntrolReboot() As Boolean ``` #### Parameters No parameters. #### Return value [Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958#Boolean) True on success or False if an error occurs. The function GetLastError returns the error number.  #### Error numbers See **[Errors](https://cue.atlassian.net/wiki/spaces/CVCDD/pages/741179402/Blustream+AMF41W#Errors)** chapter. ### ControlVideoSource This function is equivalent to the ConfigSourceSelect function. See [AMF41W ](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2)documentation:***control --video-source.*** #### Syntax ```visualbasic Function ControlVideoSource(param As ByteString) As Boolean ``` #### Parameters param [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) param - string compatible with ***control --video-source.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. #### Return value [Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958#Boolean) True on success or False if an error occurs. The function GetLastError returns the error number.  #### Error numbers See **[Errors](https://cue.atlassian.net/wiki/spaces/CVCDD/pages/741179402/Blustream+AMF41W#Errors)** chapter. ### ControlAudioSource This function is equivalent to the ConfigAudioSelect function. See [AMF41W ](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2)documentation:***control --audio-source.*** #### Syntax ```visualbasic Function ControlAudioSource(param As ByteString) As Boolean ``` #### Parameters param [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) param - string compatible with ***control --audio-source.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. #### Return value [Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958#Boolean) True on success or False if an error occurs. The function GetLastError returns the error number.  #### Error numbers See **[Errors](https://cue.atlassian.net/wiki/spaces/CVCDD/pages/741179402/Blustream+AMF41W#Errors)** chapter. ### ControlStopVideo The function stops displaying the video according to param. See [AMF41W ](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2)documentation:***control --stop-video.*** #### Syntax ```visualbasic Function ControlStopVideo(param As ByteString) As Boolean ``` #### Parameters param [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) param - string compatible with ***control --stop-video.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. #### Return value [Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958#Boolean) True on success or False if an error occurs. The function GetLastError returns the error number.  #### Error numbers See **[Errors](https://cue.atlassian.net/wiki/spaces/CVCDD/pages/741179402/Blustream+AMF41W#Errors)** chapter. ### ControlSetLayoutVideo The function starts displaying the layout according to the *param *parameter. See [AMF41W ](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2)documentation:***control --set-layout-video.*** #### Syntax ```visualbasic Function ControlSetLayoutVideo(param As ByteString) As Boolean ``` #### Parameters param [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) param - string compatible with ***control --audio-source.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. #### Return value [Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958#Boolean) True on success or False if an error occurs. The function GetLastError returns the error number.  #### Error numbers See **[Errors](https://cue.atlassian.net/wiki/spaces/CVCDD/pages/741179402/Blustream+AMF41W#Errors)** chapter. ## Layout functions ### LayoutStartVideo The function starts displaying the video according to the *param *parameter. See [AMF41W ](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2)documentation:***layout --start-video.*** #### Syntax ```visualbasic Function LayoutStartVideo(param As ByteString) As Boolean ``` #### Parameters param [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) param - string compatible with ***layout --start-video.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. #### Return value [Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958#Boolean) True on success or False if an error occurs. The function GetLastError returns the error number.  #### Error numbers See **[Errors](https://cue.atlassian.net/wiki/spaces/CVCDD/pages/741179402/Blustream+AMF41W#Errors)** chapter. ### LayoutStopVideo The function stops displaying the video according to the *param *parameter. See [AMF41W ](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2)documentation:***layout --stop-video.*** #### Syntax ```visualbasic Function LayoutStopVideo(param As ByteString) As Boolean ``` #### Parameters param [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) param - string compatible with ***layout --stop-video.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. #### Return value [Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958#Boolean) True on success or False if an error occurs. The function GetLastError returns the error number.  #### Error numbers See **[Errors](https://cue.atlassian.net/wiki/spaces/CVCDD/pages/741179402/Blustream+AMF41W#Errors)** chapter. ### LayoutAdd The function creates or modifies the layout according to the *param *parameter. See [AMF41W ](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2)documentation:***layout --add.*** #### Syntax ```visualbasic Function LayoutAdd(param As ByteString) As Boolean ``` #### Parameters param [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) param - string compatible with ***layout --add.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. #### Return value [Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958#Boolean) True on success or False if an error occurs. The function GetLastError returns the error number.  #### Error numbers See **[Errors](https://cue.atlassian.net/wiki/spaces/CVCDD/pages/741179402/Blustream+AMF41W#Errors)** chapter. ### LayoutDel The function deletes the layout according to the *param *parameter. See [AMF41W ](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2)documentation:***layout --del.*** #### Syntax ```visualbasic Function LayoutDel(param As ByteString) As Boolean ``` #### Parameters param [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) param - string compatible with ***layout --del.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. #### Return value [Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958#Boolean) True on success or False if an error occurs. The function GetLastError returns the error number.  #### Error numbers See **[Errors](https://cue.atlassian.net/wiki/spaces/CVCDD/pages/741179402/Blustream+AMF41W#Errors)** chapter. ### LayoutList The function returns the current list of layouts in the return variable *result*. See [AMF41W ](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2)documentation:***layout --list.*** #### Syntax ```visualbasic Function LayoutList(ByRef result As ByteString) As Boolean ``` #### Parameters result [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) ByRef - string compatible with ***layout --list.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. #### Return value [Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958#Boolean) True on success or False if an error occurs. The function GetLastError returns the error number.  #### Error numbers See **[Errors](https://cue.atlassian.net/wiki/spaces/CVCDD/pages/741179402/Blustream+AMF41W#Errors)** chapter. ### LayoutShow The function returns detailed information about the layout according to the *param *parameter. See [AMF41W ](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2)documentation:***layout --show.*** #### Syntax ```visualbasic Function LayoutShow(param As ByteString, ByRef result As Bytestring) As Boolean ``` #### Parameters param [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) param - string compatible with ***layout --show.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. result [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) ByRef - result string compatible with ***layout --show.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. #### Return value [Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958#Boolean) True on success or False if an error occurs. The function GetLastError returns the error number.  #### Error numbers See **[Errors](https://cue.atlassian.net/wiki/spaces/CVCDD/pages/741179402/Blustream+AMF41W#Errors)** chapter. ### LayoutSet The function starts using the layout according to the *param *parameter. See [AMF41W ](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2)documentation:***layout --set.*** #### Syntax ```visualbasic Function LayoutSet(param As ByteString) As Boolean ``` #### Parameters param [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) param - string compatible with ***layout --set.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. #### Return value [Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958#Boolean) True on success or False if an error occurs. The function GetLastError returns the error number.  #### Error numbers See **[Errors](https://cue.atlassian.net/wiki/spaces/CVCDD/pages/741179402/Blustream+AMF41W#Errors)** chapter. ### LayoutGet The function gets information about the current layout. The *param *parameter affects the detail information. See [AMF41W ](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2)documentation:***layout --get.*** #### Syntax ```visualbasic Function LayoutGet(param As ByteString, ByRef result As Bytestring) As Boolean ``` #### Parameters param [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) param - string compatible with ***layout --get.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. result [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) ByRef - result string compatible with ***layout --get.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. #### Return value [Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958#Boolean) True on success or False if an error occurs. The function GetLastError returns the error number.  #### Error numbers See **[Errors](https://cue.atlassian.net/wiki/spaces/CVCDD/pages/741179402/Blustream+AMF41W#Errors)** chapter. ### LayoutSetSequence The function activates or modifies the current set of layouts according to the *param *parameter. See [AMF41W ](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2)documentation:***layout --set-sequence.*** #### Syntax ```visualbasic Function LayoutSetSequence(param As ByteString) As Boolean ``` #### Parameters param [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) param - string compatible with ***layout --set-sequence.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. #### Return value [Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958#Boolean) True on success or False if an error occurs. The function GetLastError returns the error number.  #### Error numbers See **[Errors](https://cue.atlassian.net/wiki/spaces/CVCDD/pages/741179402/Blustream+AMF41W#Errors)** chapter. ### LayoutGetSequence The function gets information about the current set of layouts. See [AMF41W ](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2)documentation:***layout --get-sequence.*** #### Syntax ```visualbasic LayoutGetSequence(ByRef result As ByteString) As Boolean ``` #### Parameters result [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) ByRef - result string compatible with ***layout --get-sequence.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. #### Return value [Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958#Boolean) True on success or False if an error occurs. The function GetLastError returns the error number.  #### Error numbers See **[Errors](https://cue.atlassian.net/wiki/spaces/CVCDD/pages/741179402/Blustream+AMF41W#Errors)** chapter. ### LayoutAuto This function enables/disables automatic layout switching. See [AMF41W ](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2)documentation:***layout --auto.*** #### Syntax ```visualbasic LayoutAuto(param As ByteString) As Boolean ``` #### Parameters param [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) - string compatible with ***layout --auto.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. #### Return value [Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958#Boolean) True on success or False if an error occurs. The function GetLastError returns the error number.  #### Error numbers See **[Errors](https://cue.atlassian.net/wiki/spaces/CVCDD/pages/741179402/Blustream+AMF41W#Errors)** chapter. ## Scene functions ### SceneAdd The function creates/modifies the scene according to the *param *parameter. See [AMF41W ](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2)documentation:***scene --add.*** #### Syntax ```visualbasic SceneAdd(param As ByteString) As Boolean ``` #### Parameters param [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) - string compatible with ***scene --add.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. #### Return value [Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958#Boolean) True on success or False if an error occurs. The function GetLastError returns the error number.  #### Error numbers See **[Errors](https://cue.atlassian.net/wiki/spaces/CVCDD/pages/741179402/Blustream+AMF41W#Errors)** chapter. ### SceneDel The function deletes the scene according to the *param *parameter. See [AMF41W ](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2)documentation:***scene --del.*** #### Syntax ```visualbasic SceneDel(param As ByteString) As Boolean ``` #### Parameters param [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) - string compatible with ***scene --del.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. #### Return value [Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958#Boolean) True on success or False if an error occurs. The function GetLastError returns the error number.  #### Error numbers See **[Errors](https://cue.atlassian.net/wiki/spaces/CVCDD/pages/741179402/Blustream+AMF41W#Errors)** chapter. ### SceneList The function returns a list of scenes in the *result *variable. See [AMF41W ](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2)documentation:***scene --list.*** #### Syntax ```visualbasic SceneList(ByRef result As ByteString) As Boolean ``` #### Parameters result [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) ByRef - string compatible with ***scene --list.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. #### Return value [Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958#Boolean) True on success or False if an error occurs. The function GetLastError returns the error number.  #### Error numbers See **[Errors](https://cue.atlassian.net/wiki/spaces/CVCDD/pages/741179402/Blustream+AMF41W#Errors)** chapter. ### SceneShow The function returns the scene detail according to the *param *parameter. See [AMF41W ](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2)documentation:***scene --show.*** #### Syntax ```visualbasic SceneShow(param As ByteString, ByRef result As ByteString) ``` #### Parameters param [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) - string compatible with ***scene --show.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. #### result [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) ByRef - string compatible with ***scene --show.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. #### Return value [Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958#Boolean) True on success or False if an error occurs. The function GetLastError returns the error number.  #### Error numbers See **[Errors](https://cue.atlassian.net/wiki/spaces/CVCDD/pages/741179402/Blustream+AMF41W#Errors)** chapter. ### SceneApply The function activates the scene according to the *param *parameter. See [AMF41W ](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2)documentation:***scene --apply.*** #### Syntax ```visualbasic SceneApply(param As ByteString) As Boolean ``` #### Parameters param [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) - string compatible with ***scene --apply.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. #### Return value [Boolean](https://cue.atlassian.net/wiki/spaces/CVCHELP/pages/495058958#Boolean) True on success or False if an error occurs. The function GetLastError returns the error number.  #### Error numbers See **[Errors](https://cue.atlassian.net/wiki/spaces/CVCDD/pages/741179402/Blustream+AMF41W#Errors)** chapter. ## Status functions Status command is not implemented. ## Events Driver supports asynchronous events from device and synchronous events from device transmitted with the response to the command. ### AmfEvent If the event is linked, the linked function is called when the event is detected. The service fuction must be short without longer waits because the event queue inside the driver is quite short (10 items) and after it is full, the first events in the queue can be lost. #### Syntax ```visualbasic Event AmfEvent As Function(eventtype As ByteString, eventparams As ByteString) ``` #### Parameters eventtype [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) - string compatible with ***event types.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation. eventparams [ByteString](/wiki/spaces/CVCHELP/pages/495058958/Data+types#ByteString) - string compatible with ***event types.*** - see [AMF41W](https://cue.atlassian.net/wiki/download/attachments/741179402/Blustream%20amf41w%20api%20commands%20manual%20(1.0.7).pdf?api=v2) documentation.