Chan.control
From Yate Documentation
(Difference between revisions)
(Created page with " This message is used to apply various operations and parameter changes to existing channels or components. ===Parameters=== ;targetid :id of the channel to control ;compone...") |
|||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 20: | Line 20: | ||
'''Note''' | '''Note''' | ||
| − | *This message | + | *This message can be generated by the [[rmanager]] [[Rmanager Commands|command control]], in that case '''targetid''' and '''component''' are set to the same value. |
| − | *SS7 components can be controlled at runtime by [[ | + | *SS7 components can be controlled at runtime by [[Signaling_module#SS7_ISUP_commands|specific commands]]. |
*The client also uses this message for volume control. | *The client also uses this message for volume control. | ||
| + | *If the message is generated from rmanager, chan.control will succeed if the requested component is found, even if the requested operation failed to be executed. | ||
| + | |||
| + | ;rmanager control return status messages: | ||
| + | - Could not control COMMAND; If the target component is not found | ||
| + | - Control 'COMPONENT_NAME' FAILED; if the component with COMPONENT_NAME is found but failed to execute the requested operation. | ||
| + | - Control 'COMPONENT_NAME' OK; if the component with COMPONENT_NAME is found and the requested operation succeeded. | ||
| + | ;This behavior is available since revision 5396. | ||
| + | |||
| + | |||
| + | '''See also''' | ||
| + | |||
| + | *[[chan.replaced]] | ||
Latest revision as of 17:33, 8 February 2013
This message is used to apply various operations and parameter changes to existing channels or components.
[edit] Parameters
- targetid
- id of the channel to control
- component
- name of the signaling component to control
[edit] Optional parameters
Each channel and component supports various optional parameters depending on its type.
- operation
- operation to perform on the component
- out_volume
- playback volume to set in client channels
- in_volume
- recording volume to set in client channels
Note
- This message can be generated by the rmanager command control, in that case targetid and component are set to the same value.
- SS7 components can be controlled at runtime by specific commands.
- The client also uses this message for volume control.
- If the message is generated from rmanager, chan.control will succeed if the requested component is found, even if the requested operation failed to be executed.
- rmanager control return status messages
- Could not control COMMAND; If the target component is not found - Control 'COMPONENT_NAME' FAILED; if the component with COMPONENT_NAME is found but failed to execute the requested operation. - Control 'COMPONENT_NAME' OK; if the component with COMPONENT_NAME is found and the requested operation succeeded.
- This behavior is available since revision 5396.
See also
