nettoyage du repertoire debian/
[asterisk-app-conference.git] / CLI.txt
CommitLineData
c575c500
TN
1Current command line used by app_conference
2Please note that app_conference is still work in progress, so this document might be outdated. As always, the source code is the definitive reference (cli.[ch] and conference.[ch]). You can also obtain help/usage information by using Asterisk CLI help system ("help conference")
3
4A member in a conference can be referred to by its id or by its channel. Id is a positive number assigned automatically when the member joins the conference. Channel is Asterisk channel identifier. To obtain a list of member ids and channels in a conference, do:
5
6*CLI> conference list <conference name>
7
8
9- conference debug: enable debugging for a conference
10 usage: conference debug <conference_name> [ on | off ]
11
12- conference end: stops a conference
13 usage: conference end <conference name>
14
15- conference kick: kick member from a conference
16 usage: conference kick <conference_name> <member id>
17
18- conference kickchannel: kick channel from a conference
19 usage: conference kickchannel <conference_name> <channel>
20
21- conference list: list members of a conference. If no conference is specified, all conferences are listed
22 usage: conference list {conference_name}
23
24- conference lock: locks incoming video to a member
25 usage: conference lock <conference name> <member id>
26
27- conference lockchannel: locks incoming video to a channel
28 usage: conference lockchannel <conference name> <channel>
29
30- conference mute: mute member in a conference
31 usage: conference mute <conference_name> <member id>
32
33- conference mutechannel: mute channel in a conference
34 usage: conference mutechannel <channel>
35
36- conference play sound: play a sound to a conference member
37 usage: conference play sound <channel-id> <sound-file> [mute]
38 If mute is specified, all other audio is muted while the sound is played back.
39
40- conference restart: kick all users in all conferences
41 usage: conference restart
42
43- conference set default: sets default video source
44 usage: conference set default <conference name> <member>
45 use a negative value for member if you want to clear the default
46
47- conference set defaultchannel: sets default video source channel
48 usage: conference set defaultchannel <conference name> <channel>
49
50- conference show stats: show conference stats
51 usage: conference show stats
52
53- conference text: sends a text message to a member. Depends on the member's channel capabilities.
54 usage: conference text <conference name> <member> <text>
55
56- conference textbroadcast: sends a text message to all members in a conference
57 usage: conference textbroadcast <conference name> <text>
58
59- conference textchannel: sends a text message to a channel
60 usage: conference textchannel <conference name> <channel> <text>
61
62- conference unlock: unlocks incoming video
63 usage: conference unlock <conference name>
64
65- conference unmute: unmute member in a conference
66 usage: conference unmute <conference_name> <member id>
67
68- conference unmutechannel: unmute channel in a conference
69 usage: conference unmutechannel <channel>
70
71- conference video mute: mutes video from a member
72 usage: conference video mute <conference name> <member>
73
74- conference video mutechannel: mutes video from a channel
75 usage: conference video mutechannel <conference name> <channel>
76
77- conference video unmute: unmutes video from a member
78 usage: conference video unmute <conference name> <member>
79
80- conference video unmutechannel: unmutes video from a channel
81 usage: conference video unmutechannel <conference name> <channel>
82
83- conference viewchannel: switch video for a channel in a conference
84 usage: conference viewchannel <conference_name> <dest channel> <src channel>
85
86- conference viewstream: switch video for a member a conference
87 usage: conference viewstream <conference_name> <member id> <stream no>
88
89- conference drive: drive VAD video switching of destination member using audio from source member
90 usage: conference drive <conference name> <source member> [destination member]
91 If destination member is missing or negative, break existing connection
92
93- conference drivechannel: drive VAD video switching of destination channel using audio from source channel
94 usage: conference drivechannel <conference name> <source channel> [destination channel]
95 If destination channel is missing, break existing connection
96