/* * (C) Copyright 2017-2019 OpenVidu (https://openvidu.io/) * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * */ import { RecordingProperties } from './RecordingProperties'; import { RecordingLayout } from './RecordingLayout'; /** * See [[OpenVidu.startRecording]] */ export class Recording { /** * Recording unique identifier */ id: string; /** * Session associated to the recording */ sessionId: string; /** * Time when the recording started in UTC milliseconds */ createdAt: number; /** * Size of the recording in bytes (0 until the recording is stopped) */ size = 0; /** * Duration of the recording in seconds (0 until the recording is stopped) */ duration = 0; /** * URL of the recording. You can access the file from there. It is `null` until recording is stopped or if OpenVidu Server configuration property `openvidu.recording.public-access` is false */ url: string; /** * Status of the recording */ status: Recording.Status; /** * Technical properties of the recorded file */ properties: RecordingProperties; /* tslint:disable:no-string-literal */ /** * @hidden */ constructor(json: JSON) { this.id = json['id']; this.sessionId = json['sessionId']; this.createdAt = json['createdAt']; this.size = json['size']; this.duration = json['duration']; this.url = json['url']; this.status = json['status']; this.properties = { name: !!(json['name']) ? json['name'] : this.id, outputMode: !!(json['outputMode']) ? json['outputMode'] : Recording.OutputMode.COMPOSED, hasAudio: !!(json['hasAudio']), hasVideo: !!json['hasVideo'] }; if (this.properties.outputMode.toString() === Recording.OutputMode[Recording.OutputMode.COMPOSED]) { this.properties.resolution = !!(json['resolution']) ? json['resolution'] : '1920x1080'; this.properties.recordingLayout = !!(json['recordingLayout']) ? json['recordingLayout'] : RecordingLayout.BEST_FIT; if (this.properties.recordingLayout.toString() === RecordingLayout[RecordingLayout.CUSTOM]) { this.properties.customLayout = json['customLayout']; } } } /* tslint:enable:no-string-literal */ } export namespace Recording { /** * See [[Recording.status]] */ export enum Status { /** * The recording is starting (cannot be stopped) */ starting = 'starting', /** * The recording has started and is going on */ started = 'started', /** * The recording has finished OK */ stopped = 'stopped', /** * The recording has stopped but is being processed. This status will change to * stopped/available or failed when processing ends */ processing = 'processing', /** * The recording is available for downloading. This status is reached for all * stopped recordings if [OpenVidu Server configuration](https://openvidu.io/docs/reference-docs/openvidu-server-params/) * property `openvidu.recording.public-access` is true */ available = 'available', /** * The recording has failed */ failed = 'failed' } /** * See [[RecordingProperties.outputMode]] */ export enum OutputMode { /** * Record all streams in a grid layout in a single archive */ COMPOSED = 'COMPOSED', /** * Record each stream individually */ INDIVIDUAL = 'INDIVIDUAL' } }