"Fossies" - the Fresh Open Source Software Archive

Member "jitsi-meet-7315/react/features/base/tracks/actionTypes.ts" (2 Jun 2023, 3569 Bytes) of package /linux/misc/jitsi-meet-7315.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. See also the last Fossies "Diffs" side-by-side code changes report for "actionTypes.ts": jitsi-meet_8319_vs_jitsi-meet_8615.

    1 /**
    2  * The type of Redux action which sets the noSrcDataNotificationUid state representing the UID of the previous
    3  * no data from source notification. Used to check if such a notification was previously displayed.
    4  *
    5  * {
    6  *     type: SET_NO_SRC_DATA_NOTIFICATION_UID,
    7  *     uid: ?number
    8  * }
    9  */
   10 export const SET_NO_SRC_DATA_NOTIFICATION_UID = 'SET_NO_SRC_DATA_NOTIFICATION_UID';
   11 
   12 /**
   13  * The type of redux action dispatched when a track has been (locally or
   14  * remotely) added to the conference.
   15  *
   16  * {
   17  *     type: TRACK_ADDED,
   18  *     track: Track
   19  * }
   20  */
   21 export const TRACK_ADDED = 'TRACK_ADDED';
   22 
   23 /**
   24  * The type of redux action dispatched when a canceled {@code getUserMedia}
   25  * process completes either successfully or with an error (the error is ignored
   26  * and the track is immediately disposed if it has been created).
   27  *
   28  * {
   29  *     type: TRACK_CREATE_CANCELED,
   30  *     trackType: MEDIA_TYPE
   31  * }
   32  */
   33 export const TRACK_CREATE_CANCELED = 'TRACK_CREATE_CANCELED';
   34 
   35 /**
   36  * The type of redux action dispatched when {@code getUserMedia} fails with an
   37  * error (such as permission denied).
   38  *
   39  * {
   40  *     type: TRACK_CREATE_ERROR,
   41  *     permissionDenied: Boolean,
   42  *     trackType: MEDIA_TYPE
   43  * }
   44  */
   45 export const TRACK_CREATE_ERROR = 'TRACK_CREATE_ERROR';
   46 
   47 /**
   48  * The type of redux action dispatched when the track mute/unmute operation fails at the conference level. This could
   49  * happen because of {@code getUserMedia} errors during unmute or replace track errors at the peerconnection level.
   50  *
   51  * {
   52  *     type: TRACK_MUTE_UNMUTE_FAILED,
   53  *     track: Track,
   54  *     wasMuting: Boolean
   55  * }
   56  */
   57 export const TRACK_MUTE_UNMUTE_FAILED = 'TRACK_MUTE_UNMUTE_FAILED';
   58 
   59 /**
   60  * The type of redux action dispatched when a track has triggered no data from source event.
   61  *
   62  * {
   63  *     type: TRACK_NO_DATA_FROM_SOURCE,
   64  *     track: Track
   65  * }
   66  */
   67 export const TRACK_NO_DATA_FROM_SOURCE = 'TRACK_NO_DATA_FROM_SOURCE';
   68 
   69 /**
   70  * The type of redux action dispatched when the owner of a track changes due to ssrc remapping.
   71  *
   72  * {
   73  *     type: TRACK_OWNER_CHANGED,
   74  *     track: Track
   75  * }
   76  */
   77 export const TRACK_OWNER_CHANGED = 'TRACK_OWNER_CHANGED';
   78 
   79 /**
   80  * The type of redux action dispatched when a track has been (locally or
   81  * remotely) removed from the conference.
   82  *
   83  * {
   84  *     type: TRACK_REMOVED,
   85  *     track: Track
   86  * }
   87  */
   88 export const TRACK_REMOVED = 'TRACK_REMOVED';
   89 
   90 /**
   91  * The type of redux action dispatched when a track has stopped.
   92  *
   93  * {
   94  *      type: TRACK_STOPPED,
   95  *      track: Track
   96  * }
   97  */
   98 export const TRACK_STOPPED = 'TRACK_STOPPED';
   99 
  100 /**
  101  * The type of redux action dispatched when a track's properties were updated.
  102  *
  103  * {
  104  *     type: TRACK_UPDATED,
  105  *     track: Track
  106  * }
  107  */
  108 export const TRACK_UPDATED = 'TRACK_UPDATED';
  109  
  110 /**
  111  * The type of redux action dispatched when a local track starts being created
  112  * via a WebRTC {@code getUserMedia} call. The action's payload includes an
  113  * extra {@code gumProcess} property which is a {@code Promise} with an extra
  114  * {@code cancel} method which can be used to cancel the process. Canceling will
  115  * result in disposing any {@code JitsiLocalTrack} returned by the
  116  * {@code getUserMedia} callback. There will be a {@code TRACK_CREATE_CANCELED}
  117  * action instead of a {@code TRACK_ADDED} or {@code TRACK_CREATE_ERROR} action.
  118  *
  119  * {
  120  *     type: TRACK_WILL_CREATE
  121  *     track: {
  122  *         gumProcess: Promise with a `cancel` method to cancel the process,
  123  *         local: true,
  124  *         mediaType: MEDIA_TYPE
  125  *     }
  126  * }
  127  */
  128 export const TRACK_WILL_CREATE = 'TRACK_WILL_CREATE';