Copyright © TANDBERG 2008
Reference Guide Version 3.0 rev 3.0
34
5
IP VCR methods
Methods in this section are present only where the product supports video recording and playback, such as the
Codian IP VCR 2200 Series. Throughout this section, any such product is referred to as an IP VCR.
5.1
recording.callout
This replicates the call out and record functionality from the web interface.
Parameter
Type
Comments
recordingName (optional) String
The name to be used for the recording. If no name
is specified, a default name is used.
folderId (optional)
Integer
The folder in which this recording is to be placed. If
not specified, the top level folder will be used.
address
String
The hostname, IP address or e164 number to
connect to.
participantProtocol
(optional)
String Either
h323
or
sip
.
The protocol to be used for this
connection. This defaults to
h323
.
gatewayAddress (optional) String
The address of an h323 gateway, if required. Only
used if protocol is
h323
.
useSIPRegistrar (optional) Boolean
Only valid if protocol is
sip
. Defaults to false.
This may give an operation failed fault, with a reason given in the fault string, if the operation fails. In IP VCR
release 2.3 and later, if this call succeeds then the success response includes the integer “recordingId” value
used to uniquely identify the new recording. This value can then be used in later recording.configure or
recording.stop calls, for instance.
5.2
recording.configure
Configures a pre-existing recording. All configuration parameters are optional, although a "no changes
requested" fault will occur if there are no optional parameters present.
Parameter
Type
Comments
recordingId
Integer
The recording ID for the recording to modify. This
should be the identifier as returned by
recording.enumerate.
recordingName
(optional)
String
The name for the recording.
numericId (optional)
String
The numeric ID used for this recording.
pin (optional)
String
The PIN for this recording.
registerWithSIPRegistrar
(optional)
Boolean
Whether to register this recording with the sip
registrar.
registerWithGatekeeper
(optional)
Boolean
Whether to register this recording with the h323
gatekeeper.
playbackEnabled
(optional)
Boolean
Whether this recording has playback enabled.
