"Fossies" - the Fresh Open Source Software Archive

Member "jitsi-meet-7547/react/features/filmstrip/actionTypes.ts" (25 Sep 2023, 5941 Bytes) of package /linux/misc/jitsi-meet-7547.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) TypeScript source code syntax highlighting (style: standard) with prefixed line numbers and code folding option. Alternatively you can here view or download the uninterpreted source code file.

    1 /**
    2  * The type of (redux) action which enlarges the filmstrip.
    3  *
    4  * {
    5  *     type: RESIZE_FILMSTRIP,
    6  * }
    7  */
    8 export const RESIZE_FILMSTRIP = 'RESIZE_FILMSTRIP';
    9 
   10  /**
   11  * The type of (redux) action which sets whether the filmstrip is enabled.
   12  *
   13  * {
   14  *     type: SET_FILMSTRIP_ENABLED,
   15  *     enabled: boolean
   16  * }
   17  */
   18 export const SET_FILMSTRIP_ENABLED = 'SET_FILMSTRIP_ENABLED';
   19 
   20 /**
   21  * The type of (redux) action which sets whether the filmstrip is visible.
   22  *
   23  * {
   24  *     type: SET_FILMSTRIP_VISIBLE,
   25  *     visible: boolean
   26  * }
   27  */
   28 export const SET_FILMSTRIP_VISIBLE = 'SET_FILMSTRIP_VISIBLE';
   29 
   30 /**
   31  * The type of (redux) action which sets the dimensions of the tile view grid.
   32  *
   33  * {
   34  *     type: SET_TILE_VIEW_DIMENSIONS,
   35  *     dimensions: {
   36  *         gridDimensions: {
   37  *             columns: number,
   38  *             height: number,
   39  *             minVisibleRows: number,
   40  *             width: number
   41  *         },
   42  *         thumbnailSize: {
   43  *             height: number,
   44  *             width: number
   45  *         },
   46  *         filmstripWidth: number
   47  *     }
   48  * }
   49  */
   50 export const SET_TILE_VIEW_DIMENSIONS = 'SET_TILE_VIEW_DIMENSIONS';
   51 
   52 /**
   53  * The type of (redux) action which sets the dimensions of the thumbnails in horizontal view.
   54  *
   55  * {
   56  *     type: SET_HORIZONTAL_VIEW_DIMENSIONS,
   57  *     dimensions: Object
   58  * }
   59  */
   60 export const SET_HORIZONTAL_VIEW_DIMENSIONS = 'SET_HORIZONTAL_VIEW_DIMENSIONS';
   61 
   62 /**
   63  * The type of (redux) action which sets the reordered list of the remote participants in the filmstrip.
   64  * {
   65  *      type: SET_REMOTE_PARTICIPANTS,
   66  *      participants: Array<string>
   67  * }
   68  */
   69 export const SET_REMOTE_PARTICIPANTS = 'SET_REMOTE_PARTICIPANTS';
   70 
   71 /**
   72  * The type of (redux) action which sets the dimensions of the thumbnails in vertical view.
   73  *
   74  * {
   75  *     type: SET_VERTICAL_VIEW_DIMENSIONS,
   76  *     dimensions: Object
   77  * }
   78  */
   79 export const SET_VERTICAL_VIEW_DIMENSIONS = 'SET_VERTICAL_VIEW_DIMENSIONS';
   80 
   81 /**
   82  * The type of (redux) action which sets the volume for a thumnail's audio.
   83  *
   84  * {
   85  *     type: SET_VOLUME,
   86  *     participantId: string,
   87  *     volume: number
   88  * }
   89  */
   90 export const SET_VOLUME = 'SET_VOLUME';
   91 
   92 /**
   93  * The type of the action which sets the list of visible remote participants in the filmstrip by storing the start and
   94  * end index in the remote participants array.
   95  *
   96  * {
   97  *      type: SET_VISIBLE_REMOTE_PARTICIPANTS,
   98  *      startIndex: number,
   99  *      endIndex: number
  100  * }
  101  */
  102 export const SET_VISIBLE_REMOTE_PARTICIPANTS = 'SET_VISIBLE_REMOTE_PARTICIPANTS';
  103 
  104 /**
  105  * The type of action which sets the height for the top panel filmstrip.
  106  * {
  107  *      type: SET_FILMSTRIP_HEIGHT,
  108  *      height: number
  109  * }
  110  */
  111 export const SET_FILMSTRIP_HEIGHT = 'SET_FILMSTRIP_HEIGHT';
  112 
  113 /**
  114  * The type of action which sets the width for the vertical filmstrip.
  115  * {
  116  *      type: SET_FILMSTRIP_WIDTH,
  117  *      width: number
  118  * }
  119  */
  120 export const SET_FILMSTRIP_WIDTH = 'SET_FILMSTRIP_WIDTH';
  121 
  122 /**
  123  * The type of action which sets the height for the top panel filmstrip (user resized).
  124  * {
  125  *      type: SET_USER_FILMSTRIP_HEIGHT,
  126  *      height: number
  127  * }
  128  */
  129 export const SET_USER_FILMSTRIP_HEIGHT = 'SET_USER_FILMSTRIP_HEIGHT';
  130 
  131 /**
  132  * The type of action which sets the width for the vertical filmstrip (user resized).
  133  * {
  134  *      type: SET_USER_FILMSTRIP_WIDTH,
  135  *      width: number
  136  * }
  137  */
  138 export const SET_USER_FILMSTRIP_WIDTH = 'SET_USER_FILMSTRIP_WIDTH';
  139 
  140 /**
  141  * The type of action which sets whether the user is resizing or not.
  142  * {
  143  *      type: SET_USER_IS_RESIZING,
  144  *      resizing: boolean
  145  * }
  146  */
  147 export const SET_USER_IS_RESIZING = 'SET_USER_IS_RESIZING';
  148 
  149 /**
  150  * The type of (redux) action which sets the dimensions of the thumbnails in stage filmstrip view.
  151  *
  152  * {
  153  *     type: SET_STAGE_FILMSTRIP_DIMENSIONS,
  154  *     dimensions: Object
  155  * }
  156  */
  157 export const SET_STAGE_FILMSTRIP_DIMENSIONS = 'SET_STAGE_FILMSTRIP_DIMENSIONS';
  158 
  159 /**
  160  * The type of Redux action which adds a participant to the active list
  161  * (the participants displayed on the stage filmstrip).
  162  * {
  163  *     type: ADD_STAGE_PARTICIPANT,
  164  *     participantId: string,
  165  *     pinned: boolean
  166  * }
  167  */
  168 export const ADD_STAGE_PARTICIPANT = 'ADD_STAGE_PARTICIPANT';
  169 
  170 /**
  171  * The type of Redux action which removes a participant from the active list
  172  * (the participants displayed on the stage filmstrip).
  173  * {
  174  *     type: REMOVE_STAGE_PARTICIPANT,
  175  *     participantId: string,
  176  * }
  177  */
  178 export const REMOVE_STAGE_PARTICIPANT = 'REMOVE_STAGE_PARTICIPANT';
  179 
  180 /**
  181  * The type of Redux action which sets the active participants list
  182  * (the participants displayed on the stage filmstrip).
  183  * {
  184  *     type: SET_STAGE_PARTICIPANTS,
  185  *     queue: Array<Object>
  186  * }
  187  */
  188 export const SET_STAGE_PARTICIPANTS = 'SET_STAGE_PARTICIPANTS';
  189 
  190 /**
  191  * The type of Redux action which toggles the pin state of stage participants.
  192  * {
  193  *     type: TOGGLE_PIN_STAGE_PARTICIPANT,
  194  *     participantId: String
  195  * }
  196  */
  197 export const TOGGLE_PIN_STAGE_PARTICIPANT = 'TOGGLE_PIN_STAGE_PARTICIPANT';
  198 
  199 /**
  200  * The type of Redux action which clears the list of stage participants.
  201  * {
  202  *     type: CLEAR_STAGE_PARTICIPANTS
  203  * }
  204  */
  205 export const CLEAR_STAGE_PARTICIPANTS = 'CLEAR_STAGE_PARTICIPANTS';
  206 
  207 /**
  208  * The type of Redux action which sets the participant to be displayed
  209  * on the screenshare filmstrip.
  210  * {
  211  *     type: SET_SCREENSHARE_FILMSTRIP_PARTICIPANT,
  212  *     participantId: string|undefined
  213  * }
  214  */
  215 export const SET_SCREENSHARE_FILMSTRIP_PARTICIPANT = 'SET_SCREENSHARE_FILMSTRIP_PARTICIPANT';
  216 
  217 /**
  218  * The type of Redux action which sets the dimensions of the screenshare tile.
  219  * {
  220  *     type: SET_SCREENSHARING_TILE_DIMENSIONS
  221  * }
  222  */
  223 export const SET_SCREENSHARING_TILE_DIMENSIONS = 'SET_SCREENSHARING_TILE_DIMENSIONS';
  224 
  225 /**
  226  * The type of Redux action which sets the visibility of the top panel.
  227  * {
  228  *     type: SET_TOP_PANEL_VISIBILITY
  229  * }
  230  */
  231 export const SET_TOP_PANEL_VISIBILITY = 'SET_TOP_PANEL_VISIBILITY';