3 recording.delete, 4 recording.enumerate, 35 5.4 recording.enumerate – TANDBERG 3.0 User Manual

Page 39

Advertising
background image

Copyright © TANDBERG 2008

Reference Guide Version 3.0 rev 3.0

35

5.3 recording.delete

This method deletes a recording from the IP VCR.

Parameter

Type

Comments

recordingId Integer

The

recording

ID for the recording to delete.

This should be the identifier as returned by
recording.enumerate.


A "no such recording" fault is returned if the recording does not exist.

5.4 recording.enumerate

This function enumerates the recordings stored on the IP VCR.

Parameter

Type

Comments

enumerateID (optional)

String

An enumerateID, as specified in section 2.

enumerateFilter (optional) String

A filter expression.


Valid expressions within the enumerate filter are:

Expression

Type

Comments

recordingId

Integer

The unique index of this recording

internal

Boolean

True if the recording is stored internally

external

Boolean

True if the recording is stored externally

inProgress

Boolean

True if the recording is in the process of being
made


This returns the following:

Response

Type

Comments

enumerateID (optional)

String

An enumerateID, as specified in section 2.

recordings

array of structures

See below for layout of the structures.


The "recordings" array contains the following structures:

Field

Type

Comments

recordingName

String

The name of this recording.

recordingId

Integer

A unique identifier for this recording.

folderId

Integer

The unique identifier of the folder in which this
recording is stored.

numericId

String

The numeric Id registered with the SIP registrar
or h323 gatekeeper.

pin

String

The PIN of this recording.

status

String

The current status of the recording. This can be
any of the following:

idle

,

initialising

,

invalid

,

uploading

,

deleting

or

recording

.

playbackEnabled

Boolean

True if the recording can be played back by
users.

registerWithSIPRegistrar

Boolean

True if the numeric ID is registered with the SIP
registrar.

registerWithGatekeeper Boolean

True

if

the numeric ID is registered with the

h323 gatekeeper.

Advertising