commit de lancement : 2.0.1-1
[asterisk-app-conference.git] / README.videoswitch
CommitLineData
c575c500
TN
1VideoSwitch
2-----------
3(c) Vipadia Limited 2005-2006
4Neil Stratford <neils@vipadia.com>
5
6Based on app_conference, see README.
7
8Including contributions from John Martin <John.Martin@AuPix.com>
9
10Example use:
11
12exten => 2300,1,Videoswitch(test/RX)
13
14This puts the user into a conference 'test' with the options SRX.
15
16The options are the same as app_conference, except:
17
18X - enable the caller to switch video stream using DTMF
19R - relay the DTMF to the management interface
20C - Mute video - no video from this client
21c - No Receive video - send no video to this client
22L - Mute audio - no audio from this client
23l - No Receive audio - send no audio to this client
24M - member is moderator - when they leave everyone else is kicked
25
26Stream selection options: two integers, first is receive id, second is send id.
27Both are optional.
28
290-9 - Set initial receive stream to n
300-9 - Set this stream id to n (will stop any other video with that id already)
31
32eg: Videoswitch(test/01) will set our id to 1, and we will receive id 0's video
33
34CLI commands (which may also be invoked from the manager interface
35using the Command action):
36
37Most commands have two versions, which can either take a member number (obtained from 'videoswitch list') or a channel identifier (such as SIP/2304-1e82).
38
39fidwell*CLI> help videoswitch
40 videoswitch debug enable debugging for a videoswitch
41 videoswitch kick kick member from a videoswitch
42 videoswitch list list members of a videoswitch
43 videoswitch mute mute member in a videoswitch
44 videoswitch mutechannel mute channel in a videoswitch
45 videoswitch show stats show videoswitch stats
46 videoswitch unmute unmute member in a videoswitch
47videoswitch unmutechannel unmute channel in a videoswitch
48 videoswitch viewchannel switch channel in a videoswitch
49 videoswitch viewstream switch view in a videoswitch
50
51fidwell*CLI> help videoswitch debug
52usage: videoswitch debug <videoswitch_name> [ on | off ]
53 enable debugging for a videoswitch
54
55fidwell*CLI> help videoswitch kick
56usage: videoswitch kick <videoswitch_name> <member no>
57 kick member form a videoswitch
58
59fidwell*CLI> help videoswitch list
60usage: videoswitch list {<videoswitch_name>}
61 list members of a videoswitch or list of videoswitches if no name
62
63fidwell*CLI> help videoswitch mute
64usage: videoswitch mute <videoswitch_name> <member no>
65 mute member in a videoswitch
66
67fidwell*CLI> help videoswitch unmute
68usage: videoswitch unmute <videoswitch_name> <member no>
69 unmute member in a videoswitch
70
71fidwell*CLI> help videoswitch mutechannel
72usage: videoswitch mute <videoswitch_name> <channel>
73 mute channel in a videoswitch
74
75fidwell*CLI> help videoswitch unmutechannel
76usage: videoswitch unmute <videoswitch_name> <channel>
77 unmute channel in a videoswitch
78
79fidwell*CLI> help videoswitch viewchannel
80usage: videoswitch viewchannel <videoswitch_name> <dest channel> <src channel>
81 channel <dest channel> will receive video stream <src channel>
82
83fidwell*CLI> help videoswitch viewstream
84usage: videoswitch viewstream <videoswitch_name> <member no> <stream no>
85 member <member no> will receive video stream <stream no>
86
87