Table of Contents

TMS FNC WX Pack API Reference

Use this reference for exact Delphi API contracts. Start from the component pages for purpose, setup, and task guides; use the class and member pages here for signatures, defaults, behavior notes, and event contracts.

Entry Points

Route Use when
Components You want component purpose, screenshots, guide links, and the component API map.
Product guides You want cross-cutting workflows before drilling into component APIs.
Product overview You want frameworks, dependencies, IDE support, and release notes.

Component Summary

Component Use for
TMS FNC WX Audio Player Play audio files and streams using the browser audio engine.
TMS FNC WX Barcode Generate barcode images from a wide range of 1D and 2D barcode symbologies.
TMS FNC WX Barcode Decoder Decode barcode data from image files or camera streams.
TMS FNC WX Camera Capture photos and video from device camera hardware.
TMS FNC WX Container Embed arbitrary HTML elements with event wiring and script interaction inside a form control.
TMS FNC WX Docx Non-visual component for programmatic generation and export of DOCX documents.
TMS FNC WX Docx Viewer Visual viewer for rendering DOCX documents in-app without Microsoft Word.
TMS FNC WX HTML Memo Rich-text HTML editor with formatting toolbar, lists, links, and image support.
TMS FNC WX JSON Formatter Display and edit JSON with syntax highlighting and tree-view formatting.
TMS FNC WX Math Editor Mathematical expression editor supporting LaTeX, ASCIIMath, and virtual keyboard input.
TMS FNC WX OCR Extract text from images using optical character recognition.
TMS FNC WX OCR Helper Selection overlay and template helper for guided OCR region extraction.
TMS FNC WX PDF Thumbnail List Show a scrollable strip of PDF page thumbnail previews linked to a PDF Viewer.
TMS FNC WX PDF Toolbar Toolbar that controls navigation, zoom, and search actions of a linked PDF Viewer.
TMS FNC WX PDF Viewer Display and interact with PDF documents using an embedded web-based renderer.
TMS FNC WX QR Code Generate QR code images with configurable error correction and styling.
TMS FNC WX QR Decoder Decode QR code data from image files or live camera feed.
TMS FNC WX Speech Synthesis Convert text to speech using the platform speech synthesis API.
TMS FNC WX Video Player Embed and control video playback with HTML5 video capabilities.
TMS FNC WX WebRTC Communication Peer-to-peer audio, video, and data channel communication using WebRTC.

API By Component

TMS FNC WX Audio Player

Component page

Classes And Records

Type Description
TTMSFNCWXAudioPlayer Component that plays an audio source and publishes its playback options, transport state, and notification events for design-time use.
TTMSFNCWXCustomAudioPlayer Base class that hosts an embedded audio element and exposes playback control, seeking, and state for an audio source.
Type Kind Description
TTMSFNCWXMediaPlayerErrorEvent Event type (undocumented)
TTMSFNCWXMediaPlayerMediaError Enum (undocumented)
TTMSFNCWXMediaPlayerMediaEvent Event type (undocumented)
TTMSFNCWXMediaPlayerPreload Enum (undocumented)

TMS FNC WX Barcode

Component page

Classes And Records

Type Description
TTMSFNCWXBarcode Barcode component that renders a symbol of a selectable symbology from a text value. Publishes the appearance, text, border, and encoding options of TTMSFNCWXCustomBarcode for design-time use.
TTMSFNCWXBarcodeBorder Describes the optional rectangular border drawn around a rendered barcode. Controls the border color, line width, visibility, and the gap between the border and the symbol on each side.
TTMSFNCWXBarcodeSettings Holds the symbology-specific encoding options for a barcode. Each property only applies to the barcode types that support it; properties that do not apply to the active type are ignored during rendering.
TTMSFNCWXCustomBarcode Base class for the barcode control. Renders a barcode of the selected symbology from a text value through an embedded web view and exposes the appearance, text, border, and encoding options as well as the ability to retrieve the rendered image as a bitmap.
Type Kind Description
TTMSFNCWXBarcodeAusPostCustInfoEnc Enum Encoding used for the customer information field of an Australia Post barcode.
TTMSFNCWXBarcodeCodeOneVersion Enum Code One symbol version, selecting a fixed (A through H) or variable (T and S series) data capacity.
TTMSFNCWXBarcodeGetEvent Event type Signature of the event raised when a barcode bitmap has been generated.
TTMSFNCWXBarcodeImageFormat Enum Output image format produced for a rendered barcode.
TTMSFNCWXBarcodeMSICheckType Enum Check-digit algorithm applied to an MSI Plessey barcode.
TTMSFNCWXBarcodeMailmarkType Enum Mailmark barcode variant, selecting the number of data fields in the symbol.
TTMSFNCWXBarcodePZNVariant Enum Pharmazentralnummer (PZN) variant, selecting the seven- or eight-digit numbering scheme.
TTMSFNCWXBarcodePosiCodeVersion Enum PosiCode version selecting the standard or limited character set.
TTMSFNCWXBarcodeTextAlign Enum Horizontal alignment of the human-readable text under a barcode.

TMS FNC WX Barcode Decoder

Component page

Classes And Records

Type Description
TTMSFNCWXBarcodeDecoder Component that decodes barcodes from images, files, base64 data, or a live camera feed, publishing the symbology, camera, library location, and decode notifications for design-time configuration.
TTMSFNCWXCustomBarcodeDecoder Decoder that recognizes a configurable barcode symbology by running a client-side decoding library against the supplied image data.
TTMSFNCWXCustomBarcodeDecoderBase Base class that decodes barcodes from a file, an in-memory image, a base64 data stream, or live camera frames, and exposes the shared decode and scanning behavior reused by the concrete decoder components.
Type Kind Description
TTMSFNCWXCustomBarcodeDecodeCallBackEvent Event type Anonymous callback invoked once a single decode request started through a decode method has completed.
TTMSFNCWXCustomBarcodeDecodeEvent Event type Notifies the application that a decode attempt has completed and reports the outcome.

TMS FNC WX Camera

Component page

Classes And Records

Type Description
TTMSFNCWXCamera Provides the design-time camera component that streams live video from a system camera and captures snapshots, publishing the configurable properties and events of TTMSFNCWXCustomCamera.
TTMSFNCWXCameraDevice Represents a single camera input device discovered on the system, with its unique identifier and display name.
TTMSFNCWXCameraDevices Maintains the collection of camera input devices discovered for the control and provides lookup helpers by identifier and name.
TTMSFNCWXCustomCamera Implements the base camera control that streams live video from a system camera into an embedded web control and captures snapshots.
TTMSFNCWXCustomCameraResolution Holds the preferred capture resolution requested from the camera as an ideal width and height.
Type Kind Description
TAVFoundationCompletionHandler3 Event type (undocumented)
TTMSFNCWXCameraCameraType Enum Selects which physical camera or facing direction the control requests from the device.
TTMSFNCWXCameraFileLocation Enum Indicates whether the underlying web content is served from a local (offline) file or from a remote (online) location.
TTMSFNCWXCameraImageFormat Enum Identifies the image encoding used when capturing a snapshot from the camera stream.
TTMSFNCWXCustomCameraSnapshotBaseEvent Event type Notifies that a snapshot has been captured and provides the resulting image as a Base64-encoded data string.
TTMSFNCWXCustomCameraSnapshotEvent Event type Notifies that a snapshot has been captured and provides the resulting image as a bitmap.

TMS FNC WX Container

Component page

Classes And Records

Type Description
TTMSFNCWXContainer Control that hosts arbitrary HTML content in an embedded web view, organized as positioned element containers with their own markup, styling, scripting, and event-driven actions, plus a collection of resource links.
TTMSFNCWXContainerElementAction Binds a handler to a DOM event raised by a specific HTML element inside an element container. When the configured event fires in the hosted web content, the action runs and reports the event back to the application.
TTMSFNCWXContainerElementActions A collection of actions that bind handlers to DOM events of the HTML elements inside an element container.
TTMSFNCWXContainerLink Defines an external resource referenced by the hosted page, such as a script, a stylesheet link, or an inline style block.
TTMSFNCWXContainerLinks A collection of links that define the external scripts, stylesheets, and inline style blocks injected into the hosted page.
TTMSFNCWXCustomContainer Base control that hosts arbitrary HTML content in an embedded web view. It manages a collection of positioned element containers and a set of resource links, and surfaces browser events back to the application.
TTMSFNCWXElementContainer Represents a single block of HTML content hosted inside the container control, with its own markup, optional script and style, positioning, and a set of actions that respond to events from its elements.
TTMSFNCWXElementContainers A collection of element containers hosted by the container control. Each item represents an independent block of HTML content.
Type Kind Description
TTMSFNCWXContainerBaseEvent Event type Event signature used to notify the application that an HTML element raised an event in the hosted web content. Provides the event payload captured from the browser.
TTMSFNCWXContainerHTMLEvent Enum Identifies the kind of HTML DOM event an action listens for on its target element.
TTMSFNCWXContainerPosition Enum Determines where an element container is anchored within the host control area.
TTMSNFCWXContainerReturnValue Enum Selects which property of the target HTML element is read and returned in the event payload when an action fires.

TMS FNC WX Docx

Component page

Classes And Records

Type Description
TTMSFNCWXCustomDocx Base class for the document generation component. Builds a document from a structured model and exports it to a file or a Base64 encoded string through an embedded web view.
TTMSFNCWXDocx Document generation component that exposes the document model and export operations as a design-time component with published events.
Type Kind Description
TTMSFNCWXDocxDownloadAsBase64Event Event type Occurs after a document has been generated and returned as a Base64 encoded string.
TTMSFNCWXDocxDownloadAsFileEvent Event type Occurs after a document has been generated and saved to a local file.

TMS FNC WX Docx Viewer

Component page

Classes And Records

Type Description
TTMSFNCWXCustomDocxViewer Implements the document viewer that renders Word (.docx) documents in a browser-based surface, with page navigation, zooming, and rendering options. Use the published descendant for design-time use.
TTMSFNCWXDocxViewer Document viewer component that renders Word (.docx) documents and publishes the navigation, rendering options, and events for design-time use.
TTMSFNCWXDocxViewerOptions Holds the rendering options applied when a document is displayed in the viewer. Changing a value re-renders the currently loaded document.
Type Kind Description
TTMSFNCWXDocxViewerDocumentRenderedEvent Event type Notifies that document rendering has completed and reports the total number of rendered pages.
TTMSFNCWXDocxViewerLinkClickedEvent Event type Notifies that a hyperlink inside the rendered document was clicked and reports its target.
TTMSFNCWXDocxViewerPageChangedEvent Event type Notifies that the active page changed, was clicked, or scrolled into view, reporting the affected page index.

TMS FNC WX HTML Memo

Component page

Classes And Records

Type Description
TTMSFNCWXCustomHTMLMemo Base class for the HTML memo editor, a rich-text editor that lets users compose and format HTML content through a configurable toolbar. It provides programmatic formatting, content load and save, custom fonts and font sizes, read-only and spell-check modes, and notifications when the content or the current text style changes.
TTMSFNCWXHTMLMemo A rich-text HTML editor control that lets users compose and format HTML content through a configurable toolbar. It publishes the inherited editing, formatting, content, and notification features for design-time and run-time use.
TTMSFNCWXHTMLMemoButtons Aggregates the toolbar button groups of the HTML memo editor: font formatting, paragraph formatting, insert actions and miscellaneous actions. Use the grouped sub-objects to enable or disable individual buttons.
TTMSFNCWXHTMLMemoFontButtons Controls which font and character-formatting buttons appear on the editor toolbar, such as font name, font size, color, bold, italic, underline, strike-through and clear-formatting buttons.
TTMSFNCWXHTMLMemoInsertButtons Controls which insert-related buttons appear on the editor toolbar, such as the picture, link, video, table and horizontal-rule buttons.
TTMSFNCWXHTMLMemoMiscButtons Controls which miscellaneous buttons appear on the editor toolbar, such as the undo, redo and code-view buttons.
TTMSFNCWXHTMLMemoParagraphButtons Controls which paragraph-formatting buttons appear on the editor toolbar, such as the predefined style, ordered list, unordered list and paragraph-alignment buttons.
TTMSFNCWXHTMLMemoToolbar Represents the editor toolbar, controlling its overall visibility and exposing the grouped button settings that determine which actions are available to the user.
Type Kind Description
TTMSFNCWXHTMLMemoFontSizeUnit Enum Specifies the measurement unit used to express font sizes in the editor.

TMS FNC WX JSON Formatter

Component page

Classes And Records

Type Description
TTMSFNCWXCustomJSONFormatter Base class for the JSON formatter control. Renders JSON content as a collapsible, syntax-highlighted tree inside a hosted web view.
TTMSFNCWXHTMLJSONFormatterAppearance Holds the colors and font used when rendering JSON with the custom color scheme. Apply these settings by selecting the custom theme on the formatter.
TTMSFNCWXJSONFormatter Renders JSON content as a collapsible, syntax-highlighted tree inside a hosted web view. Publishes the formatting, preview, animation, and appearance settings for design-time and run-time use.
Type Kind Description
TTMSFNCWXHTMLJSONFormatterTheme Enum Identifies the color scheme used to render the formatted JSON output.

TMS FNC WX Math Editor

Component page

Classes And Records

Type Description
TTMSFNCWXCustomMathEditor Base class that hosts an interactive mathematical expression editor in an embedded web view, exposing the expression content, output formats, virtual keyboard configuration, and a full set of editing and navigation commands.
TTMSFNCWXMathEditor Interactive component for editing and rendering mathematical expressions in an embedded web view, with configurable output format and on-screen virtual keyboard.
Type Kind Description
TTMSFNCWXMathEditorResultEvent Event type Notifies that a mathematical expression result is available, carrying the produced string and the format it is expressed in.
TTMSFNCWXMathFormat Enum Identifies the textual representation in which a mathematical expression is produced or consumed by the editor.
TTMSFNCWXMathInsertionMode Enum Controls how inserted content is combined with the current expression and selection.
TTMSFNCWXMathSelectionMode Enum Controls where the selection or caret is placed after content is inserted.
TTMSFNCWXMathSpeechSelection Enum Identifies the portion of the expression that is spoken aloud relative to the current caret or selection.
TTMSFNCWXMathVirtualKeyboard Enum Identifies an individual on-screen keyboard panel that can be enabled in the editor.
TTMSFNCWXMathVirtualKeyboardLayout Enum Identifies the keyboard key arrangement used by the on-screen virtual keyboard.
TTMSFNCWXMathVirtualKeyboardMode Enum Controls when the on-screen virtual keyboard is shown to the user.
TTMSFNCWXMathVirtualKeyboardTheme Enum Identifies the visual theme applied to the on-screen virtual keyboard.
TTMSFNCWXMathVirtualKeyboards Type alias Set of on-screen keyboard panels that are made available in the editor.

TMS FNC WX OCR

Component page

Classes And Records

Type Description
TTMSFNCWXCustomOCR Base class that performs optical character recognition on images. It accepts an image from several sources, runs recognition through a pool of background workers, reports progress, and exposes the recognized text and layout. Use the published TTMSFNCWXOCR descendant on a form.
TTMSFNCWXOCR Optical character recognition component that extracts text from images. It exposes the configuration, jobs, and events of TTMSFNCWXCustomOCR as published members for use at design time.
TTMSFNCWXOCRBbox Describes the rectangular bounding box of a recognized text element, using the top-left and bottom-right corner coordinates in image pixels.
TTMSFNCWXOCRLine Represents a single recognized line of text, including its combined text, recognition confidence, location, and the individual words it contains.
TTMSFNCWXOCRLineList Owns and manages a list of recognized line results. The list owns its items and frees them when they are removed or when the list is destroyed.
TTMSFNCWXOCRParagraph Represents a single recognized paragraph, including its combined text, recognition confidence, location, and the lines it contains.
TTMSFNCWXOCRParagraphList Owns and manages a list of recognized paragraph results. The list owns its items and frees them when they are removed or when the list is destroyed.
TTMSFNCWXOCRProgress Holds progress information reported while text recognition is running, such as the active worker, the current job, and the completion ratio.
TTMSFNCWXOCRResult Holds the full outcome of a completed recognition job, including the recognized plain text, alternative export formats, the overall confidence, and the recognized paragraphs, lines, and words.
TTMSFNCWXOCRResultList Owns and manages a list of recognition results. The list owns its items and frees them when they are removed or when the list is destroyed.
TTMSFNCWXOCRWord Represents a single recognized word, including its text, the confidence of the recognition, and its location within the source image.
TTMSFNCWXOCRWordList Owns and manages a list of recognized word results. The list owns its items and frees them when they are removed or when the list is destroyed.
Type Kind Description
TTMSFNCWXOCRErrorEvent Event type Signature of the event raised when a recognition job fails.
TTMSFNCWXOCRFinishedEvent Event type Signature of the event raised when a recognition job completes successfully.
TTMSFNCWXOCRProgressEvent Event type Signature of the event raised repeatedly while a recognition job is running, to report progress.

TMS FNC WX OCR Helper

Component page

Classes And Records

Type Description
TTMSFNCWXOCRCustomHelper Base control that displays an image and lets the user draw rectangular regions over it to recognize the text they contain. It crops each selected region, submits it to an attached text recognition engine, and draws feedback over the image: an index label per selection and a confidence-colored box around each recognized word. Selection sets can be saved as reusable templates and reloaded, including from JSON.
TTMSFNCWXOCRHelper Visual control that displays an image, lets the user select regions to recognize the text they contain, and overlays recognition feedback with confidence-based highlighting. Exposes the image, recognition engine, confidence thresholds, appearance, and selection behavior as published properties for design-time configuration.
TTMSFNCWXOCRHelperAppearance Groups the fill and stroke styling used to render the selection feedback: the rectangle drawn while dragging a new selection, the committed selection outline, and the confidence-based highlighting of recognized words. Word highlights are styled by confidence band so that low, moderate, and reasonable confidence results are visually distinct.
TTMSFNCWXOCRHelperRectangle Describes a single selection region within a template as a set of edge coordinates together with the scaling factor at which the region was captured. Template rectangles are serialized so a set of selections can be reused across images.
TTMSFNCWXOCRHelperSelectionResult Represents a single selected image region and the text recognition result associated with it. Holds the cropped bitmap, its position on the source image, the recognized text and bounding boxes, and the processing state used while recognition is running.
TTMSFNCWXOCRHelperSelectionResults Owns and manages the collection of selection results created during a recognition session. Items are freed automatically when removed or when the list is cleared.
TTMSFNCWXOCRHelperSelectionTemplate A reusable, serializable set of selection regions. A template captures the rectangles selected on one image so the same regions can be applied to another image, and supports persistence to and from JSON.

TMS FNC WX PDF Thumbnail List

Component page

Classes And Records

Type Description
TTMSFNCWXCustomThumbnailList Base class for a list control that displays page thumbnails for a connected document viewer. It builds one thumbnail per page, keeps the thumbnails in sync as the document loads, and navigates the viewer to the matching page when a thumbnail is selected.
TTMSFNCWXPDFThumbnailList Control that shows a navigable list of page thumbnails for a connected PDF viewer. Selecting a thumbnail navigates the viewer to that page, and the highlighted thumbnail follows the viewer's current page.
TTMSFNCWXThumbnailListItem Represents a single thumbnail entry in a thumbnail list. Each item maps to one page of the associated document and carries the rendered preview image for that page.
TTMSFNCWXThumbnailListItems Holds the collection of thumbnail items shown by a thumbnail list. One item is created per document page.

TMS FNC WX PDF Toolbar

Component page

Classes And Records

Type Description
TTMSFNCWXCustomPDFToolbar Base implementation of the PDF toolbar control. Hosts a set of buttons that drive navigation, zooming, rotation, and file loading on a connected PDF viewer, and keeps the button enabled state in sync with the viewer.
TTMSFNCWXPDFToolbar Toolbar control that drives a connected PDF viewer. Exposes a ready-made set of buttons for opening a document, navigating pages, zooming, and rotating, and keeps button availability in sync with the viewer state.
TTMSFNCWXPDFToolbarItem Represents a single button in the toolbar. Each item is bound to a role that determines the action triggered when the button is clicked, and can display a custom bitmap and caption.
TTMSFNCWXPDFToolbarItems Holds the collection of toolbar buttons. Provides strongly typed access, insertion, and creation of toolbar items.
Type Kind Description
TTMSFNCWXPDFToolbarItemRoles Type alias Represents a set of toolbar button roles, used to enable or disable a group of buttons in a single operation.

TMS FNC WX PDF Viewer

Component page

Classes And Records

Type Description
TTMSFNCWXCustomPDFViewer Base class for the PDF viewer control. Renders documents from a URL, file or Base64 string and provides page navigation, zooming, rotation, text search, thumbnail generation and form-field extraction.
TTMSFNCWXPDFViewer PDF viewer control that displays documents from a URL, file or Base64 string and exposes page navigation, zooming, rotation, text search, thumbnail generation and form-field extraction as published members.
Type Kind Description
TTMSFNCWXPDFViewerFoundSearchText Event type Event signature raised for each match found while searching the document text.
TTMSFNCWXPDFViewerGenerateImagePage Event type Event signature raised when the active page has been rendered to an image.
TTMSFNCWXPDFViewerGenerateThumbnail Event type Event signature raised when a thumbnail image for a page has been generated.
TTMSFNCWXPDFViewerGetFormFieldsEvent Event type Event signature delivering the form field data extracted from the document.
TTMSFNCWXPDFViewerGetPageTextEvent Event type Event signature delivering the extracted text content of a page.
TTMSFNCWXPDFViewerHyperlinkClick Event type Event signature raised when a hyperlink inside the document is clicked.
TTMSFNCWXPDFViewerLoadError Event type Event signature for reporting that a document failed to load.
TTMSFNCWXPDFViewerLoaded Event type Event signature raised when a document has finished loading.
TTMSFNCWXPDFViewerNavigatePageEvent Event type Event signature raised when the viewer navigates to a different page.
TTMSFNCWXPDFViewerRotationAngle Enum Identifies the clockwise rotation applied to a rendered page.
TTMSFNCWXPDFViewerSearchTextFinishEvent Event type Event signature raised when a text search has finished, summarizing the matches.
TTMSFNCWXPDFViewerThumbnailProgressEvent Event type Event signature reporting progress while thumbnails are being generated.
TTMSFNCWXPDFViewerTouchEvent Event type Event signature for touch interactions on the rendered document.

TMS FNC WX QR Code

Component page

Classes And Records

Type Description
TTMSFNCWXCustomQRCode Base class that renders a QR code from arbitrary text inside a hosted web control. Exposes the encoded text, error-correction level, version, and a rich set of appearance settings, and can overlay a logo and background image. Published descendants surface the configuration properties at the design surface.
TTMSFNCWXQRCode Component that renders a QR code from text, publishing the encoding, appearance, title, logo, and background options for use at design time and run time.
TTMSFNCWXQRCodePositionColor Holds the colors of the three position-detection patterns (the large squares in the corners) of a QR code. Each pattern is split into an outer ring and an inner square that can be colored independently.
TTMSFNCWXQRCodeSettings Collects the visual settings that control how a QR code is rendered: module and timing colors, dot scaling, quiet-zone size, title and subtitle styling, logo placement, and automatic background-aware coloring.
Type Kind Description
TTMSFNCWXQRCodeCrossOrigin Enum Specifies the cross-origin policy applied when the QR code embeds an external image such as a logo or background, controlling whether the browser sends credentials when fetching that image.
TTMSFNCWXQRCodeErrorCorrectionLevel Enum Specifies the amount of redundant data added to a QR code so that it stays scannable when part of the image is damaged or obscured. Higher levels recover from more damage but reduce the data capacity at a given size.
TTMSFNCWXQRCodeGetEvent Event type Event signature used to deliver the rendered QR code as a bitmap to the application.

TMS FNC WX QR Decoder

Component page

Classes And Records

Type Description
TTMSFNCWXCustomQRDecoder Base class that decodes QR codes from images using an embedded web control. Provides the decoding methods, library location selection, and result dispatching that the published decoder component exposes.
TTMSFNCWXQRDecoder Web-based component that decodes QR codes from camera input or supplied images. Surfaces the camera, library location, and decode notification events for use at design time and run time.
Type Kind Description
TTMSFNCWXCustomQRFilenameDecodeCallBackEvent Event type Callback invoked when a QR code decode operation that was started with an associated file name completes.

TMS FNC WX Speech Synthesis

Component page

Classes And Records

Type Description
TTMSFNCWXCustomSpeechSynthesis Base class that drives browser-based text-to-speech, converting text into spoken audio through the host page speech engine.
TTMSFNCWXSpeechSynthesis Ready-to-use text-to-speech component that publishes voice, pitch, rate, and volume settings together with playback events for use at design time.
Type Kind Description
TTMSFNCWXSpeechSynthesisIsSpeakingEvent Event type Event signature used to notify whether speech output is currently active.

TMS FNC WX Video Player

Component page

Classes And Records

Type Description
TTMSFNCWXCustomVideoPlayer Base class for the web-based video player control. Extends the media player with video-specific behavior such as picture-in-picture mode, a poster image, and seeking helpers.
TTMSFNCWXVideoPlayer Web-based video player control. Embeds a video surface that supports playback control, seeking, picture-in-picture mode, and a poster image.

TMS FNC WX WebRTC Communication

Component page

Classes And Records

Type Description
TTMSFNCWXCustomWebRTCCommunication Base WebRTC communication control that manages media capture, peer connections, signaling events, and data channels.
TTMSFNCWXWebRTCCommunication Published WebRTC communication component for media capture, peer connections, signaling, and data channels.
TTMSFNCWXWebRTCDataChannel Describes a single data channel of a peer connection, including its name and reliability settings, for exchanging arbitrary application data alongside media.
TTMSFNCWXWebRTCDataChannels Holds the collection of data channels configured for a peer connection.
TTMSFNCWXWebRTCDevice Represents a single media device discovered during device enumeration, such as a camera, microphone, or audio output.
TTMSFNCWXWebRTCDevices Holds the collection of media devices discovered during device enumeration.
TTMSFNCWXWebRTCIceServer Describes a single STUN or TURN server used by a peer connection to discover network paths and relay media when a direct connection is not possible.
TTMSFNCWXWebRTCIceServers Holds the collection of STUN and TURN servers offered to peer connections for connectivity establishment.
TTMSFNCWXWebRTCLocalVideoSettings Configures the local audio and video tracks requested for WebRTC media capture.
TTMSFNCWXWebRTCPeer Represents a single peer connection, identified by a name, and drives offer/answer negotiation, ICE candidate exchange, and data channel messaging with one remote peer.
TTMSFNCWXWebRTCPeers Holds the collection of peer connections managed by the communication component.
Type Kind Description
TTMSFNCWXDeviceKind Enum Identifies the category of a media device reported by browser device enumeration.
TTMSFNCWXWebRTCAnswerEvent Event type Fires when a local answer has been created for a peer connection and should be sent to the remote peer through the signaling channel.
TTMSFNCWXWebRTCCameraFacingMode Enum Specifies which camera direction is preferred for local video capture.
TTMSFNCWXWebRTCDataChannelDataStreamEvent Event type Fires when a binary message is received over a data channel of a peer connection.
TTMSFNCWXWebRTCDataChannelDataStringEvent Event type Fires when a string message is received over a data channel of a peer connection.
TTMSFNCWXWebRTCDataChannelOpenEvent Event type Fires when a data channel of a peer connection becomes open and ready to send and receive messages.
TTMSFNCWXWebRTCIceCandidateEvent Event type Fires when a new local ICE candidate is gathered for a peer connection and should be forwarded to the remote peer through the signaling channel.
TTMSFNCWXWebRTCIceConnectionStateChangeEvent Event type Fires when the ICE connection state of a peer connection changes, for example to connected, disconnected, or failed.
TTMSFNCWXWebRTCNegotiationNeededEvent Event type Fires when a peer connection signals that renegotiation is required, prompting a new offer to be created.
TTMSFNCWXWebRTCOfferEvent Event type Fires when a local offer has been created for a peer connection and should be sent to the remote peer through the signaling channel.
TTMSFNCWXWebRTCPeerBundlePolicy Enum Controls how media tracks are grouped onto transports for a peer connection.
TTMSFNCWXWebRTCPeerIceTransportPolicy Enum Controls which ICE candidate types a peer connection may use when establishing connectivity.
TTMSFNCWXWebRTCUserMediaErrorEvent Event type Fires when a request for camera or microphone access fails.

See Also