5 recording.stop, 6 folder.enumerate, 36 5.6 folder.enumerate – TANDBERG 3.0 User Manual

Page 40

Advertising
background image

Copyright © TANDBERG 2008

Reference Guide Version 3.0 rev 3.0

36

5.5 recording.stop

This method stops a recording in progress on the IP VCR software version 2.2(1.15) and later. The connection
between the IP VCR and the endpoint (or endpoints) involved in the call will be dropped.

Parameter

Type

Comments

recordingId

Integer

The recording ID for the recording to stop. This
should be the recordingId as returned by
recording.enumerate.


A "no such recording" fault is returned if the recording does not exist or is not in the process of being
recorded; this method has an effect only on those recordings whose status value as returned by
“recording.enumerate” is recording.

5.6 folder.enumerate

This function enumerates all subfolders of a folder.

Parameter

Type

Comments

enumerateID (optional)

String

An enumerateID, as specified in section 2.


This returns the following structure:

Response

Type

Comments

enumerateID (optional)

String

An enumerateID, as specified in section 2.

folders

array of structures See below for layout of the structures.


The "folders" array contains the following structures:

Field

Type

Comments

folderName

String

The name of the folder.

folderId

Integer

A unique identifier for this folder.

parentFolderId (optional)

Integer

The unique identifier for the parent folder of this
folder. This is not present if the folder has no
parent (i.e. is the top level folder).

externalPath (optional)

String

The external NFS path. Only present if there is
an external path configured.

exportRecordings (optional)

Boolean

Set to true if recordings in this folder are
exported via NFS. Only present if there is an

external path configured.

registerWithGatekeeper
(optional)

Boolean

Set to true if the recordings exported externally
in this folder are to be registered with the
gatekeeper. Only present if there is an external
path configured.

public

Boolean

Set to true if this folder is publicly accessible.

pin

String

Contains the PIN of this folder.

autoAttendantId String
recordingId String
recordingConsoleId String

The numerical ids used to access these functions.
Note that these are not the same as other
instances of similar names, e.g. recordingId.
These must be unique across the device.

Advertising