Recording4 Element

  • Article

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Represents a recording of a meeting..

Syntax

<Recording4>
    <OptionList>...</OptionList>
</Recording4>

The following sections describe attributes, parent elements, and child elements.

Attributes

None.

Element Information

Parent Element

Element

Occurrence

ListRecordings4Reply Element

1

Child Element

Element

Occurrence

OptionList Element

1

Remarks

The following table specifies the options that can appear in the OptionList child element.

Option Name

Description

ACL

StringListOption Element.

Specifies the access control list. If present, access to the recording is controlled by an access control list. Each string in the string list is a member of the access control list. There is no limit to the number of user IDs that you can list. Each user ID cannot exceed 64 ASCII characters.

audienceEntryControl

EnumerationOption Element. Value range [ACL | None | Password].

Specifies how meeting attendees can join a meeting.

Billing

StringOption Element. Length range 1-255 characters.

Specifies the billing option copied from the corresponding meeting.

CreateTime

TimeOption Element. Value range yyyy-mm-ddThh:mm:ssZ.

A date and time in (ISO 8601 extended) UTC format that represents the time the recording is published and is available for viewing.

Duration

StringOption Element. Length range 0 to 231-1 characters.

Specifies the duration of the recording, in seconds.

EnableRecordingExpiration

BooleanOption Element. Value range [True | False].

Enables or disables the deletion of a recording after it is published, in accordance with the values for the recordingExpirationTimeAmount and recordingExpirationTimeType options.

If the recording expiration policy for the account is enabled, the meeting organizer cannot set the enableRecordingExpiration option to False for this recording. The account policies can only be set from the Live Meeting Manager (Administer->Roles and Policies->Edit Meeting Policies->Meeting or Recording Expiration). Therefore, if you try to set the option value to False through this element, it is automatically changed to True and the related recordingExpirationTimeAmount and recordingExpirationTimeType options are set to the maximum value allowed by the account policies.

If the recording expiration policy for the account is disabled, the meeting organizer can update the enableRecordingExpiration option to True or False.

enableRecordingExpiration, recordingExpirationTimeAmount, and recordingExpirationTimeType should normally be specified together. When you do not specify the options together, they are specified for you according to the following rules:

  • If you are attempting to change the value of an option you have set before, the value is changed to the current default value specified in the configuration database.

  • If neither the member nor current default values are present, the maximum allowed valid value for the options is used.

Added in Live Meeting service API Update for Live Meeting 2007.

Mid

StringOption Element. Length range 1–16 characters.

Specifies the mid of the meeting captured in this recording.

modifyTime

TimeOption Element. Value range yyyy-mm-ddThh:mm:ssZ.

A date and time in (ISO 8601 extended) UTC format that specifies the time the recording was last modified.

Name

StringOption Element. Length range 1–64 characters.

Specifies the name of the recording. By default, this is set to match the name option for the meeting that was recorded.

onlyOwnerCanDownload

BooleanOption Element. Value range [True | False].

If True, a meeting recording can only be downloaded by a meeting owner.

owner

StringOption Element. Length range 1–64 characters.

Represents the user that created the recording.

password

StringOption Element. Length range 1–64 characters.

Specifies the password. This option is not present if there is no password or if there is an access control list.

recordingExpirationTimeAmount

DecimalOption Element. Value range 1–1440.

Specifies the amount of time to wait before deleting a recording after it is published. The unit of time is specified in the value of the recordingExpirationTimeType option.

Usually specified in conjunction with enableRecordingExpiration and recordingExpirationTimeType. If any of these options is not specified in the request, it defaults to the existing values in the configuration database in case of recording modification. In case the organizer default value or the existing value itself is not present, the maximum allowed valid value for the options is used.

Added in Live Meeting service API Update for Live Meeting 2007.

recordingExpirationTimeType

EnumerationOption Element. Value range [minute | hour | day | month].

Specifies the unit of time to wait before deleting a recording after it is published. The amount of time is specified in the value of the recordingExpirationTimeAmount option.

Usually specified in conjunction with enableRecordingExpiration and recordingExpirationTimeAmount. If any of these options is not specified in the request, it defaults to the existing values in the configuration database in case of recording modification. In case the organizer default value or the existing value itself is not present, the maximum allowed valid value for the options is used.

Added in Live Meeting service API Update for Live Meeting 2007.

registration

BooleanOption Element. Value range [True | False].

If True, users are asked to provide their company name and e-mail address before accessing the recording. If these items are provided in the entry URL, users are not asked for them on the user interface.

reid

StringOption Element. Length range 1–16 characters.

Represents a unique identifier chosen by the system for referring to this recording.

removeTime

TimeOption Element. Value range yyyy-mm-ddThh:mm:ssZ.

A date and time in (ISO 8601 extended) UTC format that specifies the time the recording is deleted.

size

StringOption Element. Length range 0 to 231-1 characters.

Specifies the total size of all formats of the recording, in kilobytes.

startTime

TimeOption Element. Value range yyyy-mm-ddThh:mm:ssZ.

A date and time in (ISO 8601 extended) UTC format that represents the time when the presenter started recording.

status

EnumerationOption Element. Value range [Active | Undeleted | Expired | Deleted | Removed].

Describes the status of the recording.

Possible status of a recording:

Active: All newly published recordings have this status.

Deleted: All manually deleted recordings have this status.

Undeleted: All recordings restored after expiration or deletion have this status. In behavior, this status is as good as Active meetings.

Expired: All recordings expired by the background expiration thread have this status.

Removed: All recordings that are permanently deleted have this status.

Added in Live Meeting service API Update for Live Meeting 2007.

timeZone

StringOption Element. Length range 1–255 characters.

Specifies the ID of the time zone in which the corresponding recording took place.

title

StringOption Element. Length range 1-255 characters.

Specifies a more descriptive name for the recording.

An option only appears in a Recording4 if the recording has the option and it is contained in the FieldList of the corresponding request.

There are three possibilities regarding access control:

  • If there is no ACL and no Password, any user can access the recording or the recording is deleted. It is possible to distinguish these two cases by checking for the presence of the removeTime option.

  • If there is a Password, users can access the recording by entering the password, either through the user interface or in the entry URL.

  • If there is an ACL, access to the recording is controlled by the given access control list.

The ACL and Password options are mutually exclusive.

See Also

Concepts

Message Elements