NAME

Bb::Collaborate::V3::Recording - Collaborate Recording instance class

DESCRIPTION

This class is used to locate and access Collaborate recordings.

PROPERTIES

recordingId (Long)

The ELM-generated recordingId for the Collaborate session recording.

roomStartDate (HiResDate)

The actual start date and time of the session when the recording was made.

roomEndDate (HiResDate)

The actual end date and time of the session when the recording was made.

recordingURL (Str)

The URL used to access the recording. This would be the result of calling the buildRecordingUrl command with the recordingId.

secureSignOn (Bool)

Flag indicating whether extended validation is required for access to the object specified by the recordingId

creationDate (HiResDate)

The date time in milliseconds UTC that the recording file was created. This is the time when the last attendee leaves and the session stops running, not necessarily the session's scheduled end time.

recordingSize (Int)

The size of the recording file in bytes.

roomName (Str)

The scheduled session's name at the time that the session was held. Case insensitive. 1 - 255 characters.

sessionId (Int)

The ELM-generated sessionId for the scheduled session. This will be 0 if the scheduled session has been deleted but the corresponding recording has not.

METHODS

recording_url

    my $recording_url = $recording->recording_url();

Returns a URL for recording playback.

list

    my $bobs_recordings = Bb::Collaborate::V3::Recordings->(filter => {userId => 'bob'});

Returns an array of recording objects. You may filter on:

userId - Matched against chairList and nonChairList

groupingId - An Element from the groupingList

sessionId - Session identifier

creatorId - Session creator

startTime - Start of the search date/time range in milliseconds.

endTime - End of the search date/time range in milliseconds.

sessionName - The session name

set_secure_sign_on

    $recording->set_secure_sign_on(1)

Sets or unsets the recording's secure sign-on flag.

convert

    $recording->convert(format => 'mp3');

Convert the recording to mp3 (default) or mp4.

delete

    $recording->delete;

Deletes recording content from the server and removes it from any associated sessions.

cpanm Bb::Collaborate::V3

perl -MCPAN -e shell
install Bb::Collaborate::V3