| 1 | = PJSUA Command Line Interface (CLI) Manual = |
| 2 | [[BR]] |
| 3 | == '''Introduction''' == |
| 4 | CLI is a feature of pjsua that enables user to execute commands from telnet/console interface. |
| 5 | |
| 6 | Features: |
| 7 | * Command completion, the system will detect if a fraction of a word makes up a unique command. |
| 8 | * Arguments/command-params completion. |
| 9 | * Command history (the use of up and down arrow). |
| 10 | |
| 11 | CLI mode is enabled/disabled by running pjsua with these options: |
| 12 | |
| 13 | || '''--use-cli''' || Enables CLI mode || |
| 14 | || '''--cli-telnet-port=PORT''' || Telnet port, set 0 to disable telnet (default=0) || |
| 15 | || '''--no-cli-console''' || Disable console interface || |
| 16 | |
| 17 | Notes: for mobile pjsua (Android, iOS, BB10, Symbian) CLI (telnet) will be enabled by default. |
| 18 | [[BR]][[BR]] |
| 19 | == '''Commands''' == |
| 20 | Commands are specified using tree structure (commands/sub-commands). |
| 21 | i.e : to make new call use ("'''call new sip:localhost'''") |
| 22 | |
| 23 | Command shortcuts are executed on the root command without the need to specify the full command path. |
| 24 | i.e : to hangup call use ("'''g'''") and not ("'''call g'''") |
| 25 | |
| 26 | |
| 27 | Some commands might need parameters/arguments to be entered. There are 3 types of arguments: |
| 28 | * Choice. User needs to pick the option from the option list (by typing “tab” or “?” key). |
| 29 | i.e : select next account ("'''acc next'''") + tab |
| 30 | {{{ |
| 31 | [0] <sip:192.168.1.6:5060> |
| 32 | [1] *<sip:192.168.1.6:5060;transport=TCP> |
| 33 | [2] <sip:192.168.1.6:5061;transport=TLS> |
| 34 | }}} |
| 35 | Expected input : 0/1/2. ("'''acc next 1'''") |
| 36 | * Input. User needs to specify the input required by the commands. |
| 37 | i.e : answer call ("'''call answer'''") + tab |
| 38 | {{{ |
| 39 | <code> Answer code |
| 40 | }}} |
| 41 | Expected input : answer code ("'''call answer 200'''") |
| 42 | * Mixed. User is presented by Choice type and input type. |
| 43 | i.e : make new call ("call new") + tab |
| 44 | {{{ |
| 45 | [-1] All buddies |
| 46 | [0] Current dialog |
| 47 | [URL] An URL |
| 48 | }}} |
| 49 | Expected input : -1/0/destination ("'''call new 0'''" or "'''call new sip:localhost'''") |
| 50 | [[BR]][[BR]] |
| 51 | The following commands can be specified when invoking pjsua in CLI mode. |
| 52 | |
| 53 | Root commands |
| 54 | || Commands || Shortcut || Description || |
| 55 | || '''log''' || || Change log level || |
| 56 | || '''exit''' || || Exit session || |
| 57 | || '''call''' || || Call and related commands || |
| 58 | || '''im''' || || IM and presence commands || |
| 59 | || '''acc''' || || Account commands || |
| 60 | || '''audio''' || || Conference and media commands || |
| 61 | || '''stat''' || || Status and config commands || |
| 62 | || '''sleep''' || || Suspend keyboard input || |
| 63 | || '''network''' || || Detect network type || |
| 64 | || '''shutdown''' || || Shutdown application || |
| 65 | || '''restart''' || || Restart application || |
| 66 | [[BR]] |
| 67 | Call and related Commands ['''call'''] |
| 68 | || Commands || Shortcut || Description || |
| 69 | || '''new''' || || Make a new call/INVITE || |
| 70 | || '''multi''' || || Make multiple calls || |
| 71 | || '''answer''' || || Answer call || |
| 72 | || '''hangup''' || '''g''' || Hangup call || |
| 73 | || '''hangup_all''' || '''hA''' || Hangup all call || |
| 74 | || '''hold''' || '''H''' || Hold call || |
| 75 | || '''reinvite''' || '''v''' || Re-invite (release hold) || |
| 76 | || '''update''' || '''U''' || Send update request || |
| 77 | || '''next''' || ''']''' || Select next call || |
| 78 | || '''previous''' || '''[''' || Select previous call || |
| 79 | || '''transfer''' || '''x''' || Transfer call || |
| 80 | || '''transfer_replaces''' || '''X''' || Transfer replace call || |
| 81 | || '''redirect''' || '''R''' || Redirect call || |
| 82 | || '''d_2833''' || '''#''' || Send DTMF (RFC 2833) || |
| 83 | || '''d_info''' || '''*''' || Send DTMF with SIP INFO || |
| 84 | || '''dump_q''' || '''dq''' || Dump (call) quality || |
| 85 | || '''send_arb''' || '''S''' || Send arbitrary request || |
| 86 | || '''list''' || || Show current call || |
| 87 | [[BR]] |
| 88 | IM and Presence Commands ['''im'''] |
| 89 | || Commands || Shortcut || Description || |
| 90 | || '''add_b''' || '''+b''' || Add buddy || |
| 91 | || '''del_b''' || '''-b''' || Delete buddy || |
| 92 | || '''send_im''' || '''i''' || Send IM || |
| 93 | || '''sub_pre''' || || Subscribe presence || |
| 94 | || '''unsub_pre''' || || Unsubscribe presence || |
| 95 | || '''tog_state''' || || Toggle online state || |
| 96 | || '''reinvite''' || '''v''' || Hold call || |
| 97 | || '''pre_text''' || '''T''' || Specify custom presence text || |
| 98 | || '''bud_list''' || '''b''' || Show buddy list || |
| 99 | [[BR]] |
| 100 | Account Commands ['''acc'''] |
| 101 | || Commands || Shortcut || Description || |
| 102 | || '''add''' || '''+a''' || Add new account || |
| 103 | || '''del''' || '''-a''' || Delete account || |
| 104 | || '''mod''' || '''!a''' || Modify account || |
| 105 | || '''reg''' || '''rr''' || Send (Refresh) register request to register || |
| 106 | || '''unreg''' || '''ru''' || Send Register request to unregister || |
| 107 | || '''next''' || '''<''' || Select the next account for sending outgoing requests || |
| 108 | || '''previous''' || '''>''' || Select the previous account for sending outgoing requests || |
| 109 | || '''show''' || '''l''' || Show account list || |
| 110 | [[BR]] |
| 111 | Conference and Media Commands ['''audio'''] |
| 112 | || Commands || Shortcut || Description || |
| 113 | || '''list''' || '''cl''' || Show conference list || |
| 114 | || '''conf_con''' || '''cc''' || Conference connect || |
| 115 | || '''conf_dis''' || '''cd''' || Conference disconnect || |
| 116 | || '''adjust_vol''' || '''V''' || Adjust volume || |
| 117 | || '''codec_prio''' || '''Cp''' || Arrange codec priorities || |
| 118 | [[BR]] |
| 119 | Status and config Commands['''stat'''] |
| 120 | || Commands || Shortcut || Description || |
| 121 | || '''dump_stat''' || '''ds''' || Dump status || |
| 122 | || '''dump_detail''' || '''dd''' || Dump detail status || |
| 123 | || '''dump_conf''' || '''dc''' || Dump configuration to screen || |
| 124 | || '''write_setting''' || '''f''' || Write current configuration file || |
| 125 | [[BR]] |
| 126 | Video commands ['''video'''] |
| 127 | || Commands || Shortcut || Description || |
| 128 | || '''enable''' || || Enable video || |
| 129 | || '''disable''' || || Disable video || |
| 130 | || '''acc''' || || Video setting for current account || |
| 131 | || '''call''' || '''vcl''' || Video call commands/settings || |
| 132 | || '''device''' || '''vv''' || Video device commands || |
| 133 | || '''codec''' || || Video codec commands || |
| 134 | || '''win''' || || Video windows settings/commands || |
| 135 | [[BR]] |
| 136 | Video setting for current account ['''video acc'''] |
| 137 | || Commands || Shortcut || Description || |
| 138 | || '''rx''' || || Enable/disable video RX for stream in curr call || |
| 139 | || '''tx''' || || Enable/disable video TX for stream in curr call || |
| 140 | || '''add''' || || Add video stream for current call || |
| 141 | || '''enable''' || || Enable stream #N in current call || |
| 142 | || '''disable''' || || Disable stream #N in current call || |
| 143 | || '''cap''' || || Set capture dev ID for stream #N in current call || |
| 144 | [[BR]] |
| 145 | Video call commands/settings ['''video call'''] |
| 146 | || Commands || Shortcut || Description || |
| 147 | || '''rx''' || || Enable/disable video RX for stream in curr call || |
| 148 | || '''tx''' || || Enable/disable video TX for stream in curr call || |
| 149 | || '''add''' || || Add video stream for current call || |
| 150 | || '''enable''' || || Enable stream #N in current call || |
| 151 | || '''disable''' || || Disable stream #N in current call || |
| 152 | || '''cap''' || || Set capture dev ID for stream #N in current call || |
| 153 | [[BR]] |
| 154 | Video device commands ['''video device'''] |
| 155 | || Commands || Shortcut || Description || |
| 156 | || '''list''' || || Show all video devices || |
| 157 | || '''refresh''' || || Refresh video device list || |
| 158 | || '''prev''' || || Enable/disable preview for specified device ID || |
| 159 | [[BR]] |
| 160 | Video codec commands ['''video codec'''] |
| 161 | || Commands || Shortcut || Description || |
| 162 | || '''list''' || || Show video codec list || |
| 163 | || '''prio''' || || Set video codec priority || |
| 164 | || '''fps''' || || Set video codec framerate || |
| 165 | || '''bitrate''' || || Set video codec bitrate || |
| 166 | || '''size''' || || Set codec ID size/resolution || |
| 167 | [[BR]] |
| 168 | Video windows settings/commands ['''video win'''] |
| 169 | || Commands || Shortcut || Description || |
| 170 | || '''list''' || || List all active video windows || |
| 171 | || '''arrange''' || || Auto arrange windows || |
| 172 | || '''show''' || || Show specific windows || |
| 173 | || '''hide''' || || Hide specific windows || |
| 174 | || '''move''' || || Move window position || |
| 175 | || '''resize''' || || Resize window to specific width/height || |