Merge branch 'master' of https://github.com/zelloptt/zello-work-windo…

…ws-client-sdk

.gitignore

@@ -6,3 +6,6 @@ Samples/bin
 Samples/Temp/
 Samples/Sample6/obj
 Samples/Sample3/obj
+/Samples/Sample2/Release/BuildLog.htm
+/Samples/SoundSample/obj/Release/TempPE
+/Samples/MultiClientSample/obj/Release/TempPE

CMD.md

@@ -0,0 +1,38 @@
+# ZelloWork Windows app command line interface
+
+### Description
+The ZelloWork command line interface allows you to send text, voice, and image messages to the specified user or channel. The ZelloWork application must be installed and the correct user account must be configured.
+
+If the Zello app is already running, it will immediately start sending the message. If the Zello app is not running, it will start, sign in and then send the message. The result can be saved to a text file and you can customize operation timeout.
+
+### Supported switches
+
+Option | Description
+-------|-------
+/audio=`path` | The full path to the audio file contaning the message to send. The file must be in `WAV` format. Options `/audio`, `/alert`, and `/image` are mutually exclusive.
+/image=`path` | The full path of the image file to send.
+/alert=`text` | The text of the call alert to send. The text must be enclosed in quotation marks and any quotation marks inside must be escaped. Example: `"The boat is called \"Zello Star\""`
+/contact=`name` | The `name` of the contact or channel to send the message to. 
+/channel=false | _Optional._ Include this switch if the name specified by the `/contact` switch is a name of a user. By default, the message will be sent to a channel.
+/report=`file name` |  _Optional._ The name of the file where the app will write the operation result. If the file already exists, it will be appended. You can use this file to audit which messages were sent, when they were sent, and to troubleshoot issues.
+/timeout=`timeout` |  _Optional._ Operation timeout in seconds. If the app is unable to complete the operation within the specified time, it will cancel it and write an error to the report file.
+
+### Examples
+
+#### Audio message
+Send an audio message from the file `Audioclip.wav` to a channel named `This game has no name` with a timeout of `12` seconds and write the operation result to `E:\Voice\log.txt`.
+
+```shell
+"C:\Program Files\ZelloWork\ptt.exe" /contact="This game has no name"  /audio="E:\Voice\Audioclip.wav" /report="E:\Voice\log.txt" /timeout=12
+```
+
+#### Call alert
+Send a call alert with the text `Please call dispatch` to user `1182 Mike` with a timeout of `40` seconds and write the operation result to `result.txt`
+
+
+```shell
+"C:\Program Files\ZelloWork\ptt.exe" /contact="1182 Mike"  /alert="Please call dispatch" /report="result.txt" /timeout=40
+```
+
+
+

README.md

@@ -17,64 +17,64 @@ You need a Windows PC to use the SDK. To install the SDK launch the [ZelloWorkCl
 
 The SDK installs samples, documentation and registers ActiveX control (ptt.dll). Once installed you can access SDK items from Start menu.
 
-##Samples overview
+## Samples overview
 Before digging into the code you can try the compiled samples, which are located in ‘Samples\bin’ subfolder of the SDK.
 
-###Sample1.exe 
+### Sample1.exe 
 *Win32 C++ application for Windows using ActiveX control*
 
 ![Offline view](Screenshots/Sample1-1.png "Sample1.exe sign in screen")
 ![Online view](Screenshots/Sample1-2.png "Sample1.exe contact list")
 
-###Sample2.htm 
+### Sample2.htm 
 embedding Zello ActiveX control into a web-page. Use Internet Explorer to view this sample. 
 
 ![ZelloWork in IE browser](Screenshots/Sample2-1.png "ZelloWork in IE browser")
 
-###Sample3.exe 
+### Sample3.exe 
 .NET application for Windows using ActiveX control
 
 ![alt text](Screenshots/Sample3-1.png "Sample3.exe sign in screen")
 ![alt text](Screenshots/Sample3-2.png "Sample3.exe contact list")
 
-###Sample4.exe
+### Sample4.exe
 Win32 C++ application for Windows Mobile. This one is a bit tricky. To test it you have to copy the file and ptt.dll from ‘mobile’ subfolder to the mobile device and register ptt.dll there using regsvrce.exe utility.
 
 ![alt text](Screenshots/Sample4-1.png "Sample4.exe sign in screen")
 ![alt text](Screenshots/Sample4-2.png "Sample4.exe contact list")
 
-###Sample5.exe
+### Sample5.exe
 Win32 C++ application for Windows implementing custom GUI
 
 ![alt text](Screenshots/Sample5-1.png "Sample5.exe sign in screen")
 ![alt text](Screenshots/Sample5-2.png "Sample5.exe contact list")
 
-###Sample6.exe 
+### Sample6.exe 
 .NET 2.0 C# application for Windows Mobile
 
 ![alt text](Screenshots/Sample6-1.jpg "Sample6.exe sign in screen")
 ![alt text](Screenshots/Sample6-2.jpg "Sample6.exe contact list")
 
-###Sample7.exe 
+### Sample7.exe 
 Visual Basic 6 application for Windows using ActiveX control
 
 ![alt text](Screenshots/Sample7-1.png "Sample7.exe main screen")
 
-###SoundSample.exe 
+### SoundSample.exe 
 .NET 2.0 C# application implementing audio integration interfaces.
 If integration mode is active, ActiveX control doesn't use playback and rendering hardware audio devices.
 Instead host app receives uncompressed PCM audio stream for each incoming message, and provides custom PCM audio stream for each outgoing message.
 If chorus mode is active, all incoming audio messages are activated concurrently on receive, while in normal mode they are activate sequentially, one by one, similar to how Zello client normally works.
 
 ![alt text](Screenshots/SoundSample.png "SoundSample.exe main screen")
 
-###Sample8.exe
+### Sample8.exe
 Win32 C++ application for Windows based on headless SDK, implementing custom GUI 
 
 ![alt text](Screenshots/Sample5-1.png "Sample8.exe sign in screen")
 ![alt text](Screenshots/Sample5-2.png "Sample8.exe contact list")
 
-###MultiClientSample
+### MultiClientSample
 .NET 2.0 C# application based on headless SDK, implementing audio integration interfaces.
 Main window allows to create several in-proc zello clients, each one having functionality similar to SoundSample
 If integration mode is active, Zello client doesn't use playback and rendering hardware audio devices.
@@ -96,17 +96,17 @@ test8 / test
 ```
 Please note that this network / usernames is intended for quick test only. For your development you’ll need to register your own free Zello for Work network.
 
-##Exploring the code
+## Exploring the code
 
 Follow these steps to start developing with Zello for Work SDK.
 
-###Step 1. Register your development network
+### Step 1. Register your development network
 
 1.	Go to [zellowork.com](https://zellowork.com/) enter desired network name, your full name and a valid e-mail address.
 2.	An e-mail will be sent to you with the new network admin password
 3.	Log-in to the newly created network web console and add some test users. You can create up to 5  users for your testing.
 
-###Step 2. Open relevant sample and modify the code to use your network
+### Step 2. Open relevant sample and modify the code to use your network
 
 1.	Sample 2 uses HTML and JavaScript only so it could viewed and edited in any text editor
 a.	All other samples require Visual Studio 2008 or later
@@ -115,12 +115,12 @@ a.	All other samples require Visual Studio 2008 or later
 4.	Verify that you can login using the accounts you created
 5.	Test push-to-talk functionality
 
-###Step 3. Check out documentation
+### Step 3. Check out documentation
 
 1.	Explore [ZelloWork.chm](ZelloWork.chm) installed with the SDK or [online reference](https://zelloptt.github.io/zellowork-windows-client-sdk/) to see the interfaces available to your application
 2.	Contact us if you have any questions or can’t find the API method you need
 
-##Deploying your application
+## Deploying your application
 When deploying your application make sure that the following conditions are met:
 
 1.	You application installer installs and registers ptt.dll ActiveX control
@@ -135,5 +135,5 @@ All apps using Zello SDK must adhere to the following guidelines:
 * Use Zello logo and / or "Zello", "ZelloWork" names, when referencing to Zello inside of your app
 * [Send us the app for review](https://zellowork.com/contact/) before distributing the app to any third parties or customers
 
-##Additional resources
+## Additional resources
 For more information visit our website at [zellowork.com](https://zellowork.com) or send an e-mail to [support@zello.com](mailto:support@zello.com)