Oooh Engine API Reference
A reference to the APIs offered by o3h.js for use in your HTML5 modules
Classes
| Class | Description |
|---|---|
| AbstractAssetCollection | Common base class for asset collection types. |
| AbstractModuleAsset | Common base class for module asset types. |
| AmazonService | A wrapper to query data from the Amazon API |
| AnalyticService | Log tracking events |
| AssetManager | Manage IModuleAsset objects that are used to move assets in and out of the module. |
| AudioAsset | A reference to an audio file shared with the Oooh platform |
| AudioAssetCollection | A Map with string keys and AudioAsset values and shared with the Oooh platform. |
| AudioClip | Play and manage an audio file. |
| AudioManager | Used to play audio. |
| CameraComponent | A view of the camera input that can be recorded if needed for future playbacks. |
| CameraComponentConfig | Options to populate a layout element with a camera component |
| CameraMediaSource | A media source that captures the video feed of a camera on the device and outputs it. |
| Component | A generic visual element of module that's managed by the application framework and setup by the layout configuration of the module. |
| ComponentBounds | |
| ContextDataService | Allows access to data about the context the module is running in. |
| ControlManager | Manager of objects which can control the behaviour of the device. |
| ExternalObject | Base class for all objects that interact with the Oooh application. |
| FullScreenRecorder | Record the full screen of the app with the option to add meta data in real time. |
| FunctionService | Allows calls to module cloud functions. |
| GameTimer | The default ITimer implementation that tracks time based on running time of the application. |
| ImageAsset | A reference to an image file shared with the Oooh platform. |
| ImageAssetCollection | A Map with string keys and ImageAsset values and shared with the Oooh platform. |
| InputManager | Manages the collection of objects that perform processing on the device to expose user actions as inputs to the API. |
| Layout | A container holding the components that are visible on the screen. |
| LayoutManager | Manage Layout objects that are used to render different Components in the client app. |
| LocalNotificationService | Allows scheduling local notifications. |
| MediaSourceManager | Creates and manages media sources for camera capture and video playback. |
| MediaSourceRecorder | Records the video produced by an O3hMediaSource to a video asset that can be played back or exported. |
| MicrophoneAudioNode | Access the devices microphone as a node for the Web Audio API. |
| MicrophoneRecorder | Records audio from the device microphone to an audio asset that can be analyzed, played back or exported as an output asset of the module run. Use InputManager.createMicrophoneRecorder() to create an instance of this class. |
| NativeRecordButton | Manage a native record button that is always on top and is not recorded by the full screen recorder. |
| NativeUIManager | Manages native UI elements such as Buttons and RecordButtons. |
| O3hMediaSource | A media source object that acts as a producer of video content that can be displayed or recorded. |
| ReplayData | The replay data container shared with the Oooh platform. |
| ReplayDataAssetCollection | A Map with string keys and ReplayData values and shared with the Oooh platform. |
| ReplayPlayer | Play back the data that was recorded for a previous session by a ReplayRecorder. |
| ReplayRecorder | Record play session data and event to be used during a future play of the module that "challenges" this session. |
| Runtime | The entry point for all interactions with the Oooh framework. A single instance of this class is available via Instance. |
| SpeechToText | SpeechToText enables voice captured by the microphone to be transcribe into a stream of text in real time. |
| SpeechToTextConfig | This class is used to configure the speech to text configuration settings. |
| SystemSettingsService | Manages the state of system wide user settings. |
| TextureData | A reference to raw texture data sent from Oooh. |
| TransitionFunction | Enumeration containing predefined transition functions. |
| TwitchService | A wrapper to query data from the Twitch API |
| UserDataService | Allows access to platform user information. |
| UserPersistentDataService | Allows access to module data per user for storing or retrieving custom data persistently on the server. The data does not expire and is free form. |
| VideoAsset | A reference to a video file shared with the Oooh platform. |
| VideoAssetCollection | A Map with string keys and VideoAsset values and shared with the Oooh platform. |
| VideoComponent | A view of a video file who's playback can be controlled. |
| VideoComponentConfig | Options to populate a layout element with a video component |
| VideoPlayerMediaSource | A media source that outputs the playback of a video file. Provides methods for controlling the video playback. |
Abstract Classes
| Abstract Class | Description |
|---|---|
| AbstractLayout | |
| AudioRoute | Describes the physical device being used to transfer audio signals |
| CameraResolutionScale | Preset downscale factors for camera resolution. Correspond to fractions of an ideal full resolution. |
| CameraType | Identifier of a type of physical camera on the device |
| ComponentContentFillMode | Specifies how the space in a component not covered by the content or mask is filled. |
| ComponentContentScaleMode | Specifies how a component's content is scaled to fit the component bounds. |
| ComponentProperty | The properties of a component that can be animated. |
| ExitError | Enum to describe the different ways that a module can exit/complete with an error. |
| FullScreenRecorderAudioChannel | Which audio channel(s) are to be used in full screen recording. |
| HapticFeedback | Kinds of haptic feedback available. These vibrations vary in intensity, duration, and can be preset patterns. |
| HighlightType | The bucket to which the moment in the video capture belongs |
| LayoutDirection | Enumeration that controls how non-overlapping sibling layout elements are arranged. |
| LayoutPosition | Enumeration that defines a position within layout element |
| MediaSourceImageCaptureFormat | Specifies the format of an image captured from a media source with O3hMediaSource.captureImage(). |
| PlayType | Enum to describe the different ways that a module can be loaded |
| UserType | A user's type status within the application |
Enumerations
| Enumeration | Description |
|---|---|
| AmazonItemContent | Control which data is included in an Amazon API response |
| AmazonSortOrder | Control how the results of an Amazon API response are ordered |
| TwitchStreamType | Filter streams by their status |
Interfaces
| Interface | Description |
|---|---|
| AmazonImage | Describes a single image asset |
| AmazonImageOptions | Container of the 3 size options an image has |
| AmazonItem | Details about an item for sale on the amazon website. |
| AmazonItemInfo | Detailed product information |
| AmazonMultiValuedAttribute | Description of a collection of text values for a single attribute |
| AmazonOfferCondition | The condition of the item offered |
| AmazonOfferListing | Details about the current listings of the item |
| AmazonOfferMerchantInfo | Details about the merchant offering this listing |
| AmazonOfferPrice | Specifics about the price of an offer |
| AmazonOfferSavings | Specifics about the savings in an offer compared to the base price |
| AmazonOfferSummary | Summary information about offers of the item |
| AmazonSearchQuery | Data used to query the amazon search API |
| AmazonSingleValuedAttribute | Description of a single text attribute |
| AudioPlayOptions | Specifies the initial playback parameters for an audio clip. |
| CameraMediaSourceConfig | Configuration for creating a camera media source. |
| ComponentMaskOptions | Options used for masking a component with an image. |
| ComponentPropertyAnimationOptions | The options to control the animation of a component property using Component.animateProperty(). |
| CubicBezier | Defines a cubic bezier curve used for transitions. |
| GroupMetadata | |
| ILayout | |
| IModuleAsset | Represents an asset shared between a module and the platform, via a name identifier's pre-defined by the module configuration. |
| ITimer | A way to track and control a timer that can be used to drive the behaviour of other components. |
| LayoutCustomConfig | Define the arrangement of components on the screen. |
| Leaderboard | |
| LeaderboardEntry | |
| LeaderboardSubmission | Data captured from a game play to be sent to the leaderboard before completing the module |
| MediaImportConfig | Options for importing media from device storage. |
| MediaSourceImageCaptureConfig | Options for capturing an image from a media source. |
| MediaSourceRecorderConfig | Options for creating a video recorder for a media source with O3hMediaSource.createVideoRecorder() |
| MicrophoneRecorderOptions | Options for creating a microphone recorder. |
| ModuleResults | Describes the state of the module when exiting. |
| O3hEvent | Interface to listen for distinct events being triggered on an object |
| OoohMetadata | |
| Rect | A representation of a rectangle in a 2D space. |
| ReplayEvent | An event containing the data recorded during the replay. |
| StickerConfig | Configuration for defining a sticker object that can be passed into the recording layout |
| Subject | An async callback collection with a single onComplete or onError event when finished, and multiple calls to the onNext function |
| Submission | |
| SystemSettingsStates | A readonly representation of the current user's system settings. |
| Transition | A description of the change in position, size, and rotation of an object over time. |
| TwitchAccountInformation | Information about a user's twitch account - if linked to their Oooh account |
| TwitchChannelInfo | Information about a Twitch channel |
| TwitchClipInfo | Information about a Twitch clip |
| TwitchGameInfo | Information about a Twitch game |
| TwitchPagedResult | A construct to manage paging of twitch search results |
| TwitchStreamInfo | Information about a Twitch stream |
| UserInformation | Contains information about a user. |
| Vector2 | A representation of a point in a 2D space |
| Vector3 | A representation of a point in a 3D space |
| VideoMetadata | Metadata for a video asset. |
| VideoPlayerMediaSourceConfig | Configuration for creating a VideoPlayerMediaSource. |
| VideoRecordingLayoutOptions |
Variables
| Variable | Description |
|---|---|
| Instance | The entry point to the Oooh API framework. Exposes an instance of the Runtime class that used to get references to other framework objects as needed |
Type Aliases
| Type Alias | Description |
|---|---|
| ComponentPropertyValueType | The type of the value that must be passed to Component.setProperty() or Component.animateProperty() for a given property. |
| Enum | A type that represents the valid values of an enumeration. |
| O3hEventHandler | A callback function that is called when an event is raised. |
| ReadonlyObjectMap | An object used as a map with values of the given type as read-only properties. |
| SpeechType | Tune the speech recognition to expect a certain kind of speech. |
| SubjectOnComplete | A function that is called at the end when the stream has ended |
| SubjectOnError | A function that is called when an error occurs |
| SubjectOnNext | A function that is called for every update |
| VideoScaleMode | Control how the video will scale to fill the layout element. |
Updated 7 months ago