openvidu/openvidu-node-client/src/RecordingLayout.ts

47 lines
1.3 KiB
TypeScript

/*
* (C) Copyright 2017-2022 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.
*
*/
/**
* See {@link RecordingProperties.recordingLayout}
*/
export const enum RecordingLayout {
/**
* All the videos are evenly distributed, taking up as much space as possible
*/
BEST_FIT = 'BEST_FIT',
/**
* _(not available yet)_
*/
PICTURE_IN_PICTURE = 'PICTURE_IN_PICTURE',
/**
* _(not available yet)_
*/
VERTICAL_PRESENTATION = 'VERTICAL_PRESENTATION',
/**
* _(not available yet)_
*/
HORIZONTAL_PRESENTATION = 'VERTICAL_PRESENTATION',
/**
* Use your own custom recording layout. See [Custom recording layouts](/en/stable/advanced-features/recording#custom-recording-layouts) to learn more
*/
CUSTOM = 'CUSTOM'
}