jiti-meet/react/features/filmstrip/constants.js

305 lines
6.9 KiB
JavaScript

// @flow
import { BoxModel } from '../base/styles';
/**
* The size (height and width) of the small (not tile view) thumbnails.
*/
export const SMALL_THUMBNAIL_SIZE = 80;
/**
* The height of the filmstrip in narrow aspect ratio, or width in wide.
*/
export const FILMSTRIP_SIZE = SMALL_THUMBNAIL_SIZE + BoxModel.margin;
/**
* The aspect ratio of a tile in tile view.
*/
export const TILE_ASPECT_RATIO = 16 / 9;
/**
* The aspect ratio of a square tile in tile view.
*/
export const SQUARE_TILE_ASPECT_RATIO = 1;
/**
* Width below which the overflow menu(s) will be displayed as drawer(s).
*/
export const DISPLAY_DRAWER_THRESHOLD = 512;
/**
* Breakpoint past which the aspect ratio is switched in tile view.
* Also, past this breakpoint, if there are two participants in the conference, we enforce
* single column view.
* If this is to be modified, please also change the related media query from the tile_view scss file.
*/
export const ASPECT_RATIO_BREAKPOINT = 500;
/**
* Minimum height of tile for small screens.
*/
export const TILE_MIN_HEIGHT_SMALL = 150;
/**
* Minimum height of tile for large screens.
*/
export const TILE_MIN_HEIGHT_LARGE = 200;
/**
* Aspect ratio for portrait tiles.
*/
export const TILE_PORTRAIT_ASPECT_RATIO = 1 / 1.3;
/**
* The default number of visible tiles for tile view.
*/
export const TILE_VIEW_DEFAULT_NUMBER_OF_VISIBLE_TILES = 25;
/**
* The default number of columns for tile view.
*/
export const DEFAULT_MAX_COLUMNS = 5;
/**
* An extended number of columns for tile view.
*/
export const ABSOLUTE_MAX_COLUMNS = 7;
/**
* An array of attributes of the video element that will be used for adding a listener for every event in the list.
* The latest event will be stored in redux. This is currently used by torture only.
*/
export const VIDEO_TEST_EVENTS = [
'onAbort',
'onCanPlay',
'onCanPlayThrough',
'onEmptied',
'onEnded',
'onError',
'onLoadedData',
'onLoadedMetadata',
'onLoadStart',
'onPause',
'onPlay',
'onPlaying',
'onRateChange',
'onStalled',
'onSuspend',
'onWaiting'
];
/**
* Display mode constant used when video is being displayed on the small video.
*
* @type {number}
* @constant
*/
export const DISPLAY_VIDEO = 0;
/**
* Display mode constant used when the user's avatar is being displayed on
* the small video.
*
* @type {number}
* @constant
*/
export const DISPLAY_AVATAR = 1;
/**
* Maps the display modes to class name that will be applied on the thumbnail container.
*
* @type {Array<string>}
* @constant
*/
export const DISPLAY_MODE_TO_CLASS_NAME = [
'display-video',
'display-avatar-only'
];
/**
* The vertical margin of a tile.
*
* @type {number}
*/
export const TILE_VERTICAL_MARGIN = 4;
/**
* The horizontal margin of a tile.
*
* @type {number}
*/
export const TILE_HORIZONTAL_MARGIN = 4;
/**
* The horizontal margin of a vertical filmstrip tile container.
*
* @type {number}
*/
export const TILE_VERTICAL_CONTAINER_HORIZONTAL_MARGIN = 2;
/**
* The vertical margin of the tile grid container.
*
* @type {number}
*/
export const TILE_VIEW_GRID_VERTICAL_MARGIN = 14;
/**
* The horizontal margin of the tile grid container.
*
* @type {number}
*/
export const TILE_VIEW_GRID_HORIZONTAL_MARGIN = 14;
/**
* The height of the whole toolbar.
*/
export const TOOLBAR_HEIGHT = 72;
/**
* The height of the whole toolbar.
*/
export const TOOLBAR_HEIGHT_MOBILE = 60;
/**
* The size of the horizontal border of a thumbnail.
*
* @type {number}
*/
export const STAGE_VIEW_THUMBNAIL_HORIZONTAL_BORDER = 4;
/**
* The size of the vertical border of a thumbnail.
*
* @type {number}
*/
export const STAGE_VIEW_THUMBNAIL_VERTICAL_BORDER = 4;
/**
* The size of the scroll.
*
* @type {number}
*/
export const SCROLL_SIZE = 7;
/**
* The total vertical space between the thumbnails container and the edges of the window.
*
* NOTE: This will include margins, paddings and the space for the 'hide filmstrip' icon.
*
* @type {number}
*/
export const VERTICAL_FILMSTRIP_VERTICAL_MARGIN = 26;
/**
* The min horizontal space between the thumbnails container and the edges of the window.
*
* @type {number}
*/
export const VERTICAL_FILMSTRIP_MIN_HORIZONTAL_MARGIN = 10;
/**
* The total horizontal space between the thumbnails container and the edges of the window.
*
* NOTE: This will include margins, paddings and the space for the 'hide filmstrip' icon.
*
* @type {number}
*/
export const HORIZONTAL_FILMSTRIP_MARGIN = 39;
/**
* Sets after how many ms to show the thumbnail context menu on long touch on mobile.
*
* @type {number}
*/
export const SHOW_TOOLBAR_CONTEXT_MENU_AFTER = 600;
/**
* The margin for each side of the tile view. Taken away from the available
* width for the tile container to display in.
*
* NOTE: Mobile specific.
*
* @private
* @type {number}
*/
export const TILE_MARGIN = 10;
/**
* The types of thumbnails for filmstrip.
*/
export const THUMBNAIL_TYPE = {
TILE: 'TILE',
VERTICAL: 'VERTICAL',
HORIZONTAL: 'HORIZONTAL'
};
/**
* The popover position for the connection stats table.
*/
export const STATS_POPOVER_POSITION = {
[THUMBNAIL_TYPE.TILE]: 'right-start',
[THUMBNAIL_TYPE.VERTICAL]: 'left-start',
[THUMBNAIL_TYPE.HORIZONTAL]: 'top-end'
};
/**
* The tooltip position for the indicators on the thumbnail.
*/
export const INDICATORS_TOOLTIP_POSITION = {
[THUMBNAIL_TYPE.TILE]: 'right',
[THUMBNAIL_TYPE.VERTICAL]: 'left',
[THUMBNAIL_TYPE.HORIZONTAL]: 'top'
};
/**
* The default (and minimum) width for the vertical filmstrip (user resizable).
*/
export const DEFAULT_FILMSTRIP_WIDTH = 120;
/**
* The default aspect ratio for the local tile.
*/
export const DEFAULT_LOCAL_TILE_ASPECT_RATIO = 16 / 9;
/**
* The width of the filmstrip at which it no longer goes above the stage view, but it pushes it.
*/
export const FILMSTRIP_BREAKPOINT = 180;
/**
* The width of the filmstrip at which the display mode changes from column to grid.
*/
export const FILMSTRIP_GRID_BREAKPOINT = 300;
/**
* How much before the breakpoint should we display the background.
* (We display the opaque background before we resize the stage view to make sure
* the resize is not visible behind the filmstrip).
*/
export const FILMSTRIP_BREAKPOINT_OFFSET = 5;
/**
* The minimum width for the stage view
* (used to determine the maximum width of the user-resizable vertical filmstrip).
*/
export const MIN_STAGE_VIEW_WIDTH = 800;
/**
* Horizontal margin used for the vertical filmstrip.
*/
export const VERTICAL_VIEW_HORIZONTAL_MARGIN = VERTICAL_FILMSTRIP_MIN_HORIZONTAL_MARGIN
+ SCROLL_SIZE + TILE_HORIZONTAL_MARGIN + STAGE_VIEW_THUMBNAIL_HORIZONTAL_BORDER;
/**
* The time after which a participant should be removed from active participants.
*/
export const ACTIVE_PARTICIPANT_TIMEOUT = 1000 * 60;
/**
* The max number of participants to be displayed on the stage filmstrip.
*/
export const MAX_ACTIVE_PARTICIPANTS = 6;