@casual-simulation/aux-common 3.1.36 → 3.2.1-alpha.5646793078

package/bots/BotEvents.d.ts

@@ -23,7 +23,7 @@ export type ExtraActions = ShoutAction | RejectAction | ShowToastAction | ShowHt
 /**
  * Defines a set of possible async action types.
  */
-export type AsyncActions = AsyncResultAction | AsyncErrorAction | ShowInputAction | ShowConfirmAction | ShareAction | ImportAUXAction | RegisterBuiltinPortalAction | RegisterPrefixAction | RunScriptAction | LoadBotsAction | ClearSpaceAction | SendWebhookAction | AnimateTagAction | UnlockSpaceAction | SetSpacePasswordAction | LoadFileAction | SaveFileAction | SetupChannelAction | RpioInitAction | RpioExitAction | RpioOpenAction | RpioModeAction | RpioReadAction | RpioReadSequenceAction | RpioWriteAction | RpioWriteSequenceAction | RpioReadpadAction | RpioWritepadAction | RpioPudAction | RpioPollAction | RpioCloseAction | RpioI2CBeginAction | RpioI2CSetSlaveAddressAction | RpioI2CSetBaudRateAction | RpioI2CSetClockDividerAction | RpioI2CReadAction | RpioI2CWriteAction | RpioI2CEndAction | RpioPWMSetClockDividerAction | RpioPWMSetRangeAction | RpioPWMSetDataAction | RpioSPIBeginAction | RpioSPIChipSelectAction | RpioSPISetCSPolarityAction | RpioSPISetClockDividerAction | RpioSPISetDataModeAction | RpioSPITransferAction | RpioSPIWriteAction | RpioSPIEndAction | SerialConnectAction | SerialStreamAction | SerialOpenAction | SerialUpdateAction | SerialWriteAction | SerialReadAction | SerialCloseAction | SerialFlushAction | SerialDrainAction | SerialPauseAction | SerialResumeAction | CreateCertificateAction | SignTagAction | RevokeCertificateAction | RemoteAction | RemoteActionResult | RemoteActionError | DeviceAction | DeviceActionResult | DeviceActionError | PlaySoundAction | BufferSoundAction | CancelSoundAction | LocalPositionTweenAction | LocalRotationTweenAction | ShowUploadFilesAction | OpenCircleWipeAction | FocusOnBotAction | FocusOnPositionAction | BeginAudioRecordingAction | EndAudioRecordingAction | CancelAnimationAction | BeginRecordingAction | EndRecordingAction | SpeakTextAction | GetVoicesAction | GetGeolocationAction | RegisterCustomAppAction | UnregisterCustomAppAction | RegisterHtmlAppAction | RequestAuthDataAction | DefineGlobalBotAction | ConvertGeolocationToWhat3WordsAction | GetPublicRecordKeyAction | GrantRecordMarkerPermissionAction | RevokeRecordMarkerPermissionAction | GrantInstAdminPermissionAction | GrantRoleAction | RevokeRoleAction | RecordDataAction | GetRecordDataAction | ListRecordDataAction | EraseRecordDataAction | RecordFileAction | GetFileAction | EraseFileAction | RecordEventAction | GetEventCountAction | ARSupportedAction | VRSupportedAction | MediaPermissionAction | GetAverageFrameRateAction | OpenImageClassifierAction | MeetCommandAction | MeetFunctionAction | ShowTooltipAction | HideTooltipAction | JoinRoomAction | LeaveRoomAction | SetRoomOptionsAction | GetRoomOptionsAction | GetRoomTrackOptionsAction | SetRoomTrackOptionsAction | GetRoomRemoteOptionsAction | RaycastFromCameraAction | RaycastInPortalAction | CalculateRayFromCameraAction | BufferFormAddressGLTFAction | StartFormAnimationAction | StopFormAnimationAction | ListFormAnimationsAction | ConfigureWakeLockAction | GetWakeLockConfigurationAction | AnalyticsRecordEventAction | HtmlAppMethodCallAction | AttachRuntimeAction | DetachRuntimeAction;
+export type AsyncActions = AsyncResultAction | AsyncErrorAction | ShowInputAction | ShowConfirmAction | ShareAction | ImportAUXAction | RegisterBuiltinPortalAction | RegisterPrefixAction | RunScriptAction | LoadBotsAction | ClearSpaceAction | SendWebhookAction | AnimateTagAction | UnlockSpaceAction | SetSpacePasswordAction | LoadFileAction | SaveFileAction | SetupChannelAction | RpioInitAction | RpioExitAction | RpioOpenAction | RpioModeAction | RpioReadAction | RpioReadSequenceAction | RpioWriteAction | RpioWriteSequenceAction | RpioReadpadAction | RpioWritepadAction | RpioPudAction | RpioPollAction | RpioCloseAction | RpioI2CBeginAction | RpioI2CSetSlaveAddressAction | RpioI2CSetBaudRateAction | RpioI2CSetClockDividerAction | RpioI2CReadAction | RpioI2CWriteAction | RpioI2CEndAction | RpioPWMSetClockDividerAction | RpioPWMSetRangeAction | RpioPWMSetDataAction | RpioSPIBeginAction | RpioSPIChipSelectAction | RpioSPISetCSPolarityAction | RpioSPISetClockDividerAction | RpioSPISetDataModeAction | RpioSPITransferAction | RpioSPIWriteAction | RpioSPIEndAction | SerialConnectAction | SerialStreamAction | SerialOpenAction | SerialUpdateAction | SerialWriteAction | SerialReadAction | SerialCloseAction | SerialFlushAction | SerialDrainAction | SerialPauseAction | SerialResumeAction | CreateCertificateAction | SignTagAction | RevokeCertificateAction | RemoteAction | RemoteActionResult | RemoteActionError | DeviceAction | DeviceActionResult | DeviceActionError | PlaySoundAction | BufferSoundAction | CancelSoundAction | LocalPositionTweenAction | LocalRotationTweenAction | ShowUploadFilesAction | OpenCircleWipeAction | FocusOnBotAction | FocusOnPositionAction | BeginAudioRecordingAction | EndAudioRecordingAction | CancelAnimationAction | BeginRecordingAction | EndRecordingAction | SpeakTextAction | GetVoicesAction | GetGeolocationAction | RegisterCustomAppAction | UnregisterCustomAppAction | RegisterHtmlAppAction | RequestAuthDataAction | DefineGlobalBotAction | ConvertGeolocationToWhat3WordsAction | GetPublicRecordKeyAction | GrantRecordMarkerPermissionAction | RevokeRecordMarkerPermissionAction | GrantInstAdminPermissionAction | GrantRoleAction | RevokeRoleAction | RecordDataAction | GetRecordDataAction | ListRecordDataAction | EraseRecordDataAction | RecordFileAction | GetFileAction | EraseFileAction | RecordEventAction | GetEventCountAction | ARSupportedAction | VRSupportedAction | MediaPermissionAction | GetAverageFrameRateAction | OpenImageClassifierAction | MeetCommandAction | MeetFunctionAction | ShowTooltipAction | HideTooltipAction | JoinRoomAction | LeaveRoomAction | SetRoomOptionsAction | GetRoomOptionsAction | GetRoomTrackOptionsAction | SetRoomTrackOptionsAction | GetRoomRemoteOptionsAction | RaycastFromCameraAction | RaycastInPortalAction | CalculateRayFromCameraAction | BufferFormAddressGLTFAction | StartFormAnimationAction | StopFormAnimationAction | ListFormAnimationsAction | ConfigureWakeLockAction | GetWakeLockConfigurationAction | AnalyticsRecordEventAction | HtmlAppMethodCallAction | AttachRuntimeAction | DetachRuntimeAction | OpenPhotoCameraAction;
 /**
  * Defines an interface for actions that represent asynchronous tasks.
  */
@@ -447,58 +447,79 @@ export interface HideHtmlAction extends Action {
     visible: false;
 }
 /**
- * Options for the os.tweenTo(), os.moveTo(), and os.focusOn() actions.
+ * Options for {@link os.focusOn-bot}, and {@link os.focusOn-position} actions.
+ *
+ * @dochash types/os
+ * @docname FocusOnOptions
  */
 export interface FocusOnOptions {
     zoom?: number;
-    rotation?: {
-        x: number;
-        y: number;
-        /**
-         * Whether to normalize the rotation values to between 0 and 2*PI.
-         * Defaults to true. Setting this to false can be useful for rotating around a bot multiple times.
-         */
-        normalize?: boolean;
-    };
+    rotation?: FocusOnRotation;
     /**
-     * The duration in seconds that the tween should take.
+     * The duration in seconds that the animation should take.
+     * Defaults to 1.
      */
     duration?: number;
     /**
-     * The type of easing to use.
-     * If not specified then "linear" "inout" will be used.
+     * The options for easing.
+     * Can be an "easing type" or an object that specifies the type and mode.
+     * If an easing type is specified, then "inout" mode is used.
+     * If omitted, then "quadratic" "inout" is used.
      */
     easing?: EaseType | Easing;
     /**
      * The tag that should be focused.
+     * Only supported in the system portal.
      */
     tag?: string;
     /**
-     * The space of the tag that should be focused.
+     * The tag space that should be focused.
+     * Only supported in the system portal, sheet portal, and tag portals.
      */
     space?: string;
     /**
-     * The line number that should be focued.
+     * The line number that should be selected in the editor.
+     * Only supported in the system portal, sheet portal, and tag portals.
      */
     lineNumber?: number;
     /**
-     * The column number that should be focused.
+     * The column number that should be selected in the editor.
+     * Only supported in the system portal, sheet portal, and tag portals.
      */
     columnNumber?: number;
     /**
      * The index of the first character that should be selected.
+     * Only supported in the system portal, sheet portal, and tag portals.
      */
     startIndex?: number;
     /**
      * The index of the last character that should be selected.
+     * Only supported in the system portal, sheet portal, and tag portals.
      */
     endIndex?: number;
     /**
-     * The portal that the bot is in.
-     * If not specified, then the bot will be focused in all portals.
+     * The portal that the bot should be focused in.
+     * If not specified, then the bot will be focused in all the portals it is in. (bot, mini and menu)
+     * Useful if a bot is in two portals but you only want to focus it in one portal.
      */
     portal?: PortalType;
 }
+/**
+ * Defines an interface that represents a rotation in polar coordinates for use with {@link os.focusOn-bot}.
+ *
+ * @dochash types/os
+ * @docname FocusOnRotation
+ */
+export interface FocusOnRotation {
+    x: number;
+    y: number;
+    /**
+     * Whether to normalize the rotation. Normalized rotations are clamped to between 0 and Math.PI*2.
+     * You can set this to false to allow using angles more than Math.PI*2. This would allow the camera to rotate around an object multiple times.
+     * Defaults to true.
+     */
+    normalize?: boolean;
+}
 /**
  * An event that is used to focus on a given bot.
  */
@@ -531,6 +552,9 @@ export interface CancelAnimationAction extends AsyncAction {
 }
 /**
  * The possible camera types.
+ *
+ * @dochash types/os
+ * @docname CameraType
  */
 export type CameraType = 'front' | 'rear';
 /**
@@ -569,6 +593,89 @@ export interface OpenBarcodeScannerAction extends Action {
      */
     disallowSwitchingCameras: boolean;
 }
+/**
+ * An event that is used to show or hide the photo camera.
+ */
+export interface OpenPhotoCameraAction extends AsyncAction {
+    type: 'open_photo_camera';
+    /**
+     * Whether the photo camera should be visible.
+     */
+    open: boolean;
+    /**
+     * Whether only a single photo should be taken.
+     */
+    singlePhoto: boolean;
+    /**
+     * The options for the action.
+     */
+    options: OpenPhotoCameraOptions;
+}
+/**
+ * Defines a photo that was taken.
+ *
+ * @dochash types/camera
+ * @docname Photo
+ */
+export interface Photo {
+    /**
+     * The photo data.
+     */
+    data: Blob;
+    /**
+     * The width of the photo in pixels.
+     */
+    width: number;
+    /**
+     * The height of the photo in pixels.
+     */
+    height: number;
+}
+/**
+ * Options for {@link os.openPhotoCamera}.
+ *
+ * @dochash types/camera
+ * @doctitle Camera Types
+ * @docsidebar Camera
+ * @docdescription Types that are used in camera actions.
+ * @docname PhotoCameraOptions
+ */
+export interface OpenPhotoCameraOptions {
+    /**
+     * The camera that should be used.
+     */
+    cameraType?: CameraType;
+    /**
+     * Whether to not allow switching the camera.
+     */
+    disallowSwitchingCameras?: boolean;
+    /**
+     * The image format that should be used.
+     *
+     * Defaults to "png".
+     */
+    imageFormat?: 'png' | 'jpeg';
+    /**
+     * A number between 0 and 1 indicating the image quality to be used.
+     *
+     * If not specified, then the browser will use its own default.
+     */
+    imageQuality?: number;
+    /**
+     * Whether to skip allowing the user to confirm their photo.
+     *
+     * Defaults to false.
+     */
+    skipConfirm?: boolean;
+    /**
+     * Whether to automatically take a photo after a number of seconds.
+     *
+     * If null, then there is no timer and the user is allowed to take the photo manually.
+     * If positive, then the timer will start counting down from the given number of seconds.
+     * The user can always cancel the operation manually.
+     */
+    takePhotoAfterSeconds?: number;
+}
 /**
  * An event that is used to toggle whether the console is open.
  */
@@ -595,6 +702,9 @@ export interface ShowQRCodeAction extends Action {
 }
 /**
  * The list of possible barcode formats.
+ *
+ * @dochash types/os
+ * @docname BarcodeFormat
  */
 export type BarcodeFormat = 'code128' | 'code39' | 'ean13' | 'ean8' | 'upc' | 'itf14' | 'msi' | 'pharmacode' | 'codabar';
 /**
@@ -618,12 +728,20 @@ export interface ShowBarcodeAction extends Action {
 /**
  * An event that is used to show or hide an image classifier on screen.
  */
-export interface OpenImageClassifierAction extends AsyncAction {
+export interface OpenImageClassifierAction extends AsyncAction, ImageClassifierOptions {
     type: 'show_image_classifier';
     /**
      * Whether the image classifier should be visible.
      */
     open: boolean;
+}
+/**
+ * Defines an interface that represents a set of options for {@link os.openImageClassifier}.
+ *
+ * @dochash types/os
+ * @docname ImageClassifierOptions
+ */
+export interface ImageClassifierOptions {
     /**
      * The URL that the model should be loaded from.
      */
@@ -643,7 +761,6 @@ export interface OpenImageClassifierAction extends AsyncAction {
      */
     cameraType?: CameraType;
 }
-export type ImageClassifierOptions = Pick<OpenImageClassifierAction, 'modelUrl' | 'modelJsonUrl' | 'modelMetadataUrl' | 'cameraType'>;
 /**
  * An event that is used to load a simulation.
  */
@@ -946,6 +1063,9 @@ export interface ShowConfirmAction extends AsyncAction {
 }
 /**
  * Defines an interface that represents the options that can be used for a confirmation dialog.
+ *
+ * @dochash types/os
+ * @docname ShowConfirmOptions
  */
 export interface ShowConfirmOptions {
     /**
@@ -1051,6 +1171,9 @@ export interface DownloadAction extends Action {
 }
 /**
  * Defines an interface for options that a show input event can use.
+ *
+ * @dochash types/os
+ * @docname ShowInputOptions
  */
 export interface ShowInputOptions {
     /**
@@ -1770,6 +1893,9 @@ export interface ShowChatBarAction {
 }
 /**
  * Defines the possible options for showing the chat bar.
+ *
+ * @dochash types/os
+ * @docname ShowChatOptions
  */
 export interface ShowChatOptions {
     /**
@@ -1953,10 +2079,38 @@ export interface LocalFormAnimationAction {
     animation: number | string;
 }
 export type TweenType = 'position' | 'rotation';
+/**
+ * The possible easing types.
+ * @dochash types/animation
+ * @docname EaseType
+ */
 export type EaseType = 'linear' | 'quadratic' | 'cubic' | 'quartic' | 'quintic' | 'sinusoidal' | 'exponential' | 'circular' | 'elastic';
+/**
+ * The possible easing modes.
+ * @dochash types/animation
+ * @docname EaseMode
+ */
 export type EaseMode = 'in' | 'out' | 'inout';
+/**
+ * Defines an interface that represents easing types.
+ *
+ * @example Create an object that represents "quadratic" "inout" easing
+ * let easing = {
+ *    type: "quadratic",
+ *    mode: "inout"
+ * };
+ *
+ * @dochash types/animation
+ * @docname Easing
+ */
 export interface Easing {
+    /**
+     * The type of easing to use.
+     */
     type: EaseType;
+    /**
+     * The mode of easing to use.
+     */
     mode: EaseMode;
 }
 /**
@@ -2013,6 +2167,9 @@ export interface LocalRotationTweenAction extends LocalTweenAction {
 }
 /**
  * Defines an interface that represents the options that an EnableARAction or EnableVRAction can have.
+ *
+ * @dochash types/os
+ * @docname EnableXROptions
  */
 export interface EnableXROptions {
     /**
@@ -2115,6 +2272,9 @@ export interface ExitFullscreenAction {
 }
 /**
  * Defines the options that a share action can have.
+ *
+ * @dochash types/os
+ * @docname ShareOptions
  */
 export interface ShareOptions {
     /**
@@ -2322,6 +2482,9 @@ export interface RegisterPrefixAction extends AsyncAction {
 }
 /**
  * Defines an interface that contains options for register prefix actions.
+ *
+ * @dochash types/core
+ * @docname RegisterPrefixOptions
  */
 export interface RegisterPrefixOptions {
     /**
@@ -2383,10 +2546,17 @@ export interface AddDropSnapTargetsAction extends AddDropSnapAction {
 /**
  * Defines an interface that represents a snap point.
  * That is, a point in 3D space with an associated snap distance.
+ *
+ * @dochash types/os
+ * @docgroup 10-snap
+ * @docorder 1
+ * @docname SnapPoint
  */
 export interface SnapPoint {
     /**
      * The 3D position for the point.
+     *
+     * @docsource Vector3
      */
     position: {
         x: number;
@@ -2401,10 +2571,17 @@ export interface SnapPoint {
 /**
  * Defines an interface that represents a snap axis.
  * That is, a ray in 3D space with an associated snap distance.
+ *
+ * @dochash types/os
+ * @docgroup 10-snap
+ * @docorder 2
+ * @docname SnapAxis
  */
 export interface SnapAxis {
     /**
      * The 3D direction that the axis ray travels along.
+     *
+     * @docsource Vector3
      */
     direction: {
         x: number;
@@ -2413,6 +2590,8 @@ export interface SnapAxis {
     };
     /**
      * The 3D position that the ray starts at.
+     *
+     * @docsource Vector3
      */
     origin: {
         x: number;
@@ -2426,10 +2605,15 @@ export interface SnapAxis {
 }
 /**
  * The list of possible snap targets.
- * - "ground" means that the dragged bot should snap to the ground plane. This option is overriden by "grid".
- * - "grid" means that the dragged bot should snap to grid tiles.
- * - "face" means that the dragged bot should snap to other bot faces.
- * - "bots" means that the dragged bot will snap to other bots.
+ * - `"ground"` means that the dragged bot should snap to the ground plane. This option is overriden by "grid".
+ * - `"grid"` means that the dragged bot should snap to grid tiles.
+ * - `"face"` means that the dragged bot should snap to other bot faces.
+ * - `"bots"` means that the dragged bot will snap to other bots.
+ *
+ * @dochash types/os
+ * @docgroup 10-snap
+ * @docorder 0
+ * @docname SnapTarget
  */
 export type SnapTarget = 'ground' | 'grid' | 'face' | 'bots' | SnapPoint | SnapAxis;
 /**
@@ -2541,19 +2725,38 @@ export interface EndAudioRecordingAction extends AsyncAction {
 }
 /**
  * An interface that represents the options that can be used for making recordings.
+ *
+ * @dochash types/experimental
+ * @doctitle Experimental Types
+ * @docsidebar Experimental
+ * @docdescription Defines the types that are used by experimental actions.
+ * @docname RecordingOptions
  */
 export interface RecordingOptions {
     /**
      * Whether to record audio.
+     *
+     * If the computer does not have an audio device attached, then setting this to true
+     * will cause an error.
+     *
      * If an array is specified, only the specified audio sources will be recorded.
+     *
+     * Defaults to true.
      */
     audio: boolean | ('screen' | 'microphone')[];
     /**
      * Whether to record video.
+     *
+     * If the computer does not have a video device attached (like a web cam),
+     * then setting this to true will cause an error.
+     *
+     * Defaults to true.
      */
     video: boolean;
     /**
      * Whether to record the screen.
+     *
+     * Defaults to false.
      */
     screen: boolean;
 }
@@ -2629,6 +2832,9 @@ export interface GetVoicesAction extends AsyncAction {
 }
 /**
  * Defines an interface that represents a synthetic voice.
+ *
+ * @dochash types/experimental
+ * @docname SyntheticVoice
  */
 export interface SyntheticVoice {
     /**
@@ -2650,6 +2856,26 @@ export interface SyntheticVoice {
 export interface GetGeolocationAction extends AsyncAction {
     type: 'get_geolocation';
 }
+/**
+ * Defines the possible geolocation results.
+ *
+ * @dochash types/os
+ * @doctitle OS Types
+ * @docsidebar OS
+ * @docdescription Defines the types that are used by OS actions.
+ * @docgroup 01-geo
+ * @docorder 0
+ * @docname Geolocation
+ */
+export type Geolocation = SuccessfulGeolocation | UnsuccessfulGeolocation;
+/**
+ * Defines an interface that represents a successful geolocation result.
+ *
+ * @dochash types/os
+ * @docgroup 01-geo
+ * @docorder 1
+ * @docname SuccessfulGeolocation
+ */
 export interface SuccessfulGeolocation {
     success: true;
     /**
@@ -2690,6 +2916,14 @@ export interface SuccessfulGeolocation {
      */
     timestamp: number;
 }
+/**
+ * Defines an interface that represents an unsuccessful geolocation result.
+ *
+ * @dochash types/os
+ * @docgroup 01-geo
+ * @docorder 2
+ * @docname UnsuccessfulGeolocation
+ */
 export interface UnsuccessfulGeolocation {
     success: false;
     /**
@@ -2701,12 +2935,11 @@ export interface UnsuccessfulGeolocation {
      */
     errorMessage?: string;
 }
-/**
- * Defines an interface that represents a geolocation result.
- */
-export type Geolocation = SuccessfulGeolocation | UnsuccessfulGeolocation;
 /**
  * Defines an interface that contains recorded data.
+ *
+ * @dochash types/experimental
+ * @docname Recording
  */
 export interface Recording {
     /**
@@ -2714,6 +2947,12 @@ export interface Recording {
      */
     files: RecordedFile[];
 }
+/**
+ * Defines an interface that represents a recorded file.
+ *
+ * @dochash types/experimental
+ * @docname RecordedFile
+ */
 export interface RecordedFile {
     /**
      * Whether the file contains the recorded audio.
@@ -2809,6 +3048,12 @@ export interface DefineGlobalBotAction extends AsyncAction {
 export declare const APPROVED_SYMBOL: unique symbol;
 /**
  * Defines an interface that represents the base for options for a records action.
+ *
+ * @dochash types/records/extra
+ * @doctitle Extra Record Types
+ * @docsidebar Extra
+ * @docdescription Extra types that are used for records.
+ * @docname RecordActionOptions
  */
 export interface RecordActionOptions {
     /**
@@ -2828,12 +3073,18 @@ export interface RecordsAction extends AsyncAction {
 /**
  * Defines a type that represents a policy that indicates which users are allowed to affect a record.
  *
- * True indicates that any user can edit the record.
- * An array of strings indicates the list of users that are allowed to edit the record.
+ * - `true` indicates that any user can edit the record.
+ * - An array of strings indicates the list of users that are allowed to edit the record.
+ *
+ * @dochash types/records
+ * @docname RecordUserPolicyType
  */
 export type RecordUserPolicyType = true | string[];
 /**
  * The options for data record actions.
+ *
+ * @dochash types/records
+ * @docName DataRecordOptions
  */
 export interface DataRecordOptions extends RecordActionOptions {
     /**
@@ -2848,6 +3099,10 @@ export interface DataRecordOptions extends RecordActionOptions {
      * The markers that should be applied to the record.
      */
     markers?: string[];
+    /**
+     * The marker that should be applied to the record.
+     */
+    marker?: string;
 }
 /**
  * Defines an interface that represents the base for actions that deal with data records.
@@ -3030,6 +3285,11 @@ export interface GetRecordsActionResult {
 }
 /**
  * Defines an interface that represents options for converting a geolocation to a what3words address.
+ *
+ * @dochash types/os
+ * @docgroup 01-geo
+ * @docorder 3
+ * @docname ConvertGeolocationToWhat3WordsOptions
  */
 export interface ConvertGeolocationToWhat3WordsOptions {
     /**
@@ -3173,6 +3433,12 @@ export interface RevokeRoleAction extends RecordsAction {
      */
     inst?: string;
 }
+/**
+ * Defines an interface that represents options for requesting media permissions.
+ *
+ * @dochash types/os
+ * @docname MediaPermissionOptions
+ */
 export interface MediaPermssionOptions {
     /**
      * Should include audio permission.
@@ -3195,6 +3461,10 @@ export interface MediaPermissionAction extends AsyncAction, MediaPermssionOption
 export interface GetAverageFrameRateAction extends AsyncAction {
     type: 'get_average_frame_rate';
 }
+/**
+ * @docid JoinRoomActionOptions
+ * @docrename RoomJoinOptions
+ */
 export type JoinRoomActionOptions = RecordActionOptions & Partial<RoomJoinOptions>;
 /**
  * Defines an event that attempts to join a meeting room.
@@ -3236,6 +3506,9 @@ export interface SetRoomOptionsAction extends AsyncAction {
 }
 /**
  * Defines a set of options that the local user can have for a room.
+ *
+ * @dochash types/os
+ * @docname RoomOptions
  */
 export interface RoomOptions {
     /**
@@ -3253,6 +3526,9 @@ export interface RoomOptions {
 }
 /**
  * Defines a set of options that the local usr can specify when joining a room.
+ *
+ * @dochash types/os
+ * @docname RoomJoinOptions
  */
 export interface RoomJoinOptions extends RoomOptions {
     /**
@@ -3320,6 +3596,12 @@ export interface SetRoomTrackOptionsAction extends AsyncAction {
      */
     options: SetRoomTrackOptions;
 }
+/**
+ * Defines an interface that represents the set of options that can be set on a room video/audio track.
+ *
+ * @dochash types/os
+ * @docname SetRoomTrackOptions
+ */
 export interface SetRoomTrackOptions {
     /**
      * Whether to mute the track locally.
@@ -3331,6 +3613,12 @@ export interface SetRoomTrackOptions {
      */
     videoQuality?: TrackVideoQuality;
 }
+/**
+ * Defines an interface that represents the options that a audio/video track has.
+ *
+ * @dochash types/os
+ * @docname RoomTrackOptions
+ */
 export interface RoomTrackOptions {
     /**
      * Whether the track is being sourced from a remote user.
@@ -3370,6 +3658,12 @@ export interface RoomTrackOptions {
 }
 export type TrackKind = 'video' | 'audio';
 export type TrackSource = 'camera' | 'microphone' | 'screen_share' | 'screen_share_audio';
+/**
+ * Defines the possible qualities that a track can stream at.
+ *
+ * @dochash types/os
+ * @docname TrackVideoQuality
+ */
 export type TrackVideoQuality = 'high' | 'medium' | 'low' | 'off';
 /**
  * Defines an event that retrieves the options for a remote multimedia chat room user.
@@ -3387,6 +3681,9 @@ export interface GetRoomRemoteOptionsAction extends AsyncAction {
 }
 /**
  * Defines an interface that contains options for a remote room user.
+ *
+ * @dochash types/os
+ * @docname RoomRemoteOptions
  */
 export interface RoomRemoteOptions {
     /**
@@ -3469,6 +3766,9 @@ export interface BufferFormAddressGLTFAction extends AsyncAction {
 }
 /**
  * Defines an interface that contains a bunch of options for starting an animation.
+ *
+ * @dochash types/os
+ * @docname StartFormAnimationOptions
  */
 export interface StartFormAnimationOptions {
     /**
@@ -3539,6 +3839,9 @@ export interface StartFormAnimationAction extends AsyncAction, StartFormAnimatio
 }
 /**
  * Defines an interface that contains a bunch of options for stopping an animation.
+ *
+ * @dochash types/os
+ * @docname StopFormAnimationOptions
  */
 export interface StopFormAnimationOptions {
     /**
@@ -3573,6 +3876,9 @@ export interface ListFormAnimationsAction extends AsyncAction {
 }
 /**
  * Defines an interface that contains animation information.
+ *
+ * @dochash types/os
+ * @docname FormAnimationData
  */
 export interface FormAnimationData {
     /**
@@ -3862,6 +4168,13 @@ export declare function showQRCode(open: boolean, code?: string): ShowQRCodeActi
  * @param cameraType The camera type that should be used.
  */
 export declare function openBarcodeScanner(open: boolean, cameraType?: CameraType): OpenBarcodeScannerAction;
+/**
+ * Creates a new OpenPhotoCameraAction.
+ * @param open Whether the barcode scanner should be open or closed.
+ * @param singlePhoto Whether only a single photo should be taken.
+ * @param cameraType The camera type that should be used.
+ */
+export declare function openPhotoCamera(open: boolean, singlePhoto: boolean, options?: OpenPhotoCameraOptions, taskId?: string | number): OpenPhotoCameraAction;
 /**
  * Creates a new ShowBarcodeAction.
  * @param open Whether the barcode should be visible.