streaming_data

Manages streaming data.

Format

• [-v] [-V] -c --channel [--description ] [--execution-uri ] [--media-server-input-uri ]
• [--media-server-address ] [--port-limit] [--volume] [--synchronous]
• [-v] [-V] -e --channel
• [-v] [-V] -e --conference-id
• [-v] [-V] -i --channel --description --execution-uri [--media-server-input-uri]
• [--media-server-output-uri] [--port-limit] [--volume] [--synchronous]
• [-v] [-V] -i --conference-id --lim --media-server-address --media-server-input-uri --media-server-output-uri
• [-v] [-V] -p --channel
• [-v] [-V] -p --conference-id

Function

This command is used to configure data for Mitel 68xx/69xx terminals to request streaming. The configuration is both for terminals and media server. The 68xx/69xx phones limit the number of channels that can be initiated and presented per key to 30.

Parameters

• -c, --change

  Change some settings that is reconfiguration of an item (or several items).

  The switch takes no arguments.

• --channel

  The internal name of the channel used for identification.

  This parameter is used when programing dynamic channels. A dynamic channel is connected upon a request from a user. Use "all" to print all channels.

  The switch requires an argument. The argument is single-valued.

• --conference-id

  The conference identity or conference key. This parameter is used when programming static channels. A static channel is setup during start phase 1.5. Use "all" to print all conference identities.

  The switch requires an argument. The argument is single-valued.

• --description

  Text presented on the terminal as a menu item. The 'narrow' string will be converted to ISO 10646-UCS-4 (Unicode) 'wide' string. In this conversion the 'narrow' string can hold 'quoted' unicode numbers of unicode characters. A quote character is used to switch between narrow text mode and unicode number mode in the input 'narrow' string. In unicode number mode the numbers are according to ISO 10646-UCS-4 see for instance http://std.dkuug.dk/JTC1/SC2/WG2/.

  In unicode number mode the numbers are separated by space ' ', or by semicolon ';'. The numbers in unicode number mode are decimal or hexadecimal. (Hexadecimal numbers must begin with 0x.). The default quote character is the percent sign '%', but that can be changed using the environment variable $_MD_UNICODE_QUOTE_CHAR. To input the quote character itself, the unicode number for the quote character must be given in unicode number mode. (To input '%' if '%' is quote character, insert '%37%'.)

  Example: To input the fictitious German company name 'Üßü-GmbH' (transcribed as Uessue-GmbH), with correct German characters, without a German keyboard, the input would be '%0xdc 0xdf 0xfc%-GmbH'..

  The argument is single-valued. Text presented on the terminal as a menu item.

• -e, --erase

  Erase some settings. That is, deconfiguration of an item (or several items). The switch takes no arguments.

• --execution-uri

  The execution uri string is an order sent to the terminal. It contains information about what to listen to. The system handles 2 types of execute items RTP streams and WAV files. This parameter is directly found in XML API for Mitel SIP phones section RTP streaming. For unicast RTP only the listening port is of significance. If the stream is ordered from an external server and is unicast we do not know the address.

  Then this item must contain a null uri, that is, "RTPRx:0.0.0.0:60000" . This item may contain several execute items which then are separated with ";"

  For instance: "RTPRx:Stop;Wav.Stop:"

  Syntax for file type execution uri's "Wav.Play:[tftp://||http://[user:[password]@] <host>(:port] [/<path>]/file" "Wav.Stop"

  Syntax for RTP type execution uri's

  "RTPRx/RTPRMx:i:p:" "RTPRx:Stop (stops both unicast and multicast)

  Where,

  • i is IP address to receive stream from.

  • p is base port to receive stream from.

  • RTPRx - is uni-cast RTP.

  • RTPRMx - is multi-cast RTP.

  The switch requires an argument. The argument is single-valued.

• -i, --initiate

  Initiate some settings. That is, make initial configuration of an item (or several items). The switch takes no arguments.

• -l, --lim

  Lim number. Server where conference resides. Syntax of argument is L where L is lim number [range: 1 - 124]. Example of valid syntax: 2

  The switch requires an argument. The argument is single-valued.

• --media-server-address

  The server IP address where the channel/conference shall reside. This address is programmed for Class-less Inter-Domain Routing (CIDR), and will be matched to the closest media server address. If the parameter is omitted, the system will use the ordering terminal’s data and domain data to find a media server. When a static channel is programmed, use a complete address (; for example, 10.20.30.40).

  The switch requires an argument. The argument is single-valued.

• --media-server-input-uri

  The input to media server, this may be an IP address + port or a path to a file.

  This parameter in conjunction with --media-server-output-uri is used when selection of this channel shall result in a media server connection.

  The switch requires an argument. The argument is single-valued.

• --media-server-output-uri

  Used for static channels only. The uri the media server shall send the output to.

  The switch requires an argument. The argument is single-valued.

• --port-limit

  Port limit from which ports for RTP to the terminal is selected. The port value in the execution-uri is the lower limit, the port-limit value added to the execution-uri port is the upper limit. The port is then randomly selected between these two numbers. If this parameter is omitted the port from execution-uri is always selected. Care must be taken so ports do not match other RTP ports used by terminals. See description for terminals. The number of ports must be less than or equal to 1000. See documentation for terminals for more information.

  The switch requires an argument. The argument is single-valued.

• -p, --print

  Print all or some settings. That is, print configuration of an item, several items, or all items. The switch takes no arguments.

• --synchronous

  Synchronous refers to the media server connection. A synchronous connection will if a file is played always start from the beginning. The connection will be one to one. A non synchronous connection will connect as a sunfan, and if it is already playing a new part will be added at the current playing position. Allowed values are: '1', 't', 'true', 'y', 'yes', '0', 'f', 'false', 'n', 'no'. Default value is 0/false.

  The switch requires an argument. The argument is single-valued.

• -v, --verbose

  Turn on verbose output (that is, progress information) to standard error. The switch takes no arguments.

• -v, --verbose-to-syslog

  Turn on verbose logging to syslog (usually to /var/log/messages). The switch takes no arguments.

• --volume

  Play back relative to stream volume. -12 +12 (dB), in steps of 1(dB). Default value is -6 dB.

  The switch requires an argument. The argument is single-valued.

Examples

• Initiate a multicast channel for terminals to stream from. No new connection in media server is required. Multicast IP address and port is 232.0.0.1 and 60000. RTPMRx means a multicast address.

  streaming_data -i --channel Radio11 --description "Radio channel 1" --execution-uri "RTPMRx:232.0.0.1:60000"

• Initiate a channel for listening to a file example.wav from uri 10.30.101.26 port 8080 using http. No new connection in media server is required.

  streaming_data -i --channel file_channel --description "File channel 1" --execution-uri "Wav.Play:http://10.30.101.26:8080/example.wav"

• Initiate a unicast channel on the media server to play at -6db. Address to media server is an exact match to 10.12.101.2/32. Address where media server is taking the stream from is http://192.123.44.2:60000.

  The stream is sending to the requesting terminal, and therefore the execution uri shall be 0.0.0.0. The selected ports shall be 60000-61000. The playing shall not be synchronized.

  streaming_data -i --channel Radio4 --description"Radio channel 4" --execution-uri "RTPRx:0.0.0.0:60000" --media-server-input-uri "http://192.123.44.2:60000" --media-server-address "10.12.101.2/32" --port-limit 1000 --volume -6

• Initiate a file on the media server to play synchronously. Address to media server is an exact match to 10.12.101.2/32. Address where media server is taking the stream from is "http://10.30.101.26:8080/welcomeMsg.wav". The stream is sending to the requesting terminal and the execution uri shall therefore be 0.0.0.0.

  streaming_data -i --channel Radio1 --description "Radio channel 1" --execution-uri "RTPRx:0.0.0.0:60000" --media-server-input-uri "http://10.30.101.26:8080/welcomeMsg.wav" --media-server-address "10.12.101.2/32" --synchronous true

• Initiate a channel with two items to stop both RTP and Wav streaming.

  streaming_data -i --channel stop --description "Stop streaming" --execution-uri "RTPRx:Stop;Wav.Stop:"

• Initiate a static multicast channel for continuous output. Use MX-ONE resource in LIM 1. Conference id is "multicast_radio_1". Address to media server is 192.168.26.60.

  The address where media server is taking the stream from shall be "rtp://10.30.101.26:8080"

  Address where media server is sending multicast to shall be "rtp://232.0.0.2:60000".

  streaming_data -i -l 1 --conference-id "multicast_radio_1" --media-server-address 192.168.26.60 --media-server-input-uri "rtp://10.30.101.26:8080"--media-server-output-uri "rtp://232.0.0.2:60000"

• Change the description on media channel Radio1.

  streaming_data -c --channel Radio1 --description "Radio channel 1"

• Erase channel Radio2.

  streaming_data -e --channel "Radio2"

• Erase conference identity multicast_radio_1.

  streaming_data -i -l 1 --conference-id "multicast_radio_1"