XmaxSDK library
The Flutter entry point for XmaxSDK.
Classes
- DefaultTrajectoryEffectRenderer
- The default interaction trail renderer, with a white core and green glow.
- DownlinkVideoStatistics
- Statistics for the incoming RTC video stream.
- MediaServicing
- Media sizing rules for a realtime model.
- RealtimeAudioFrame
- An owned packet of signed, little-endian, interleaved 16-bit remote PCM.
- RealtimeConfiguration
- The model and adaptive quality settings for a realtime manager.
- RealtimeContext
- The prompt and optional reference image path for realtime generation.
- RealtimeExternalAudioFrame
- Ready interleaved PCM samples supplied by an external source.
- RealtimeExternalFrameSink
- Receives frames for one external source attachment.
- RealtimeExternalVideoFrame
- Upright pixels supplied by an external source.
- RealtimeExternalVideoSource
- Supplies video captured, decoded, or processed by your app, with optional PCM audio.
- RealtimeMediaFrame
- One remote audio or video packet with a shared stream identity and time basis.
- RealtimeMediaFrameContent
- An owned audio or video payload on the receiver rendering timeline.
- RealtimeMediaStream
- A local input or remote output media stream for realtime generation.
- RealtimeNetworkQuality
- The uplink and downlink quality from one RTC sample.
- RealtimePerformanceAlarm
- A performance status and optional suggested format, not an applied capture configuration.
- RealtimeReason
- The reason for entering a realtime state.
- RealtimeState
- A snapshot of the realtime lifecycle state.
- RealtimeVideoFormat
- The dimensions, frame rate, and uplink encoding settings for realtime video.
- RealtimeVideoFrame
- An owned decoded video frame in packed, planar I420 format.
- RealtimeVideoTrack
- A realtime video track with dynamic metadata.
- TrajectoryEffectRendering
- An interface for custom trail effects, handling pointer events and providing an overlay view.
- TrajectoryID
- The identifier of a pointer trail, distinguishing simultaneous trails.
- TrajectoryPoint
- Trail rendering input containing a pointer identifier, view position, normalized position, and timestamp.
- UplinkVideoStatistics
- Statistics for the outgoing RTC video stream.
- XmaxClient
- A client that provides access to Xmax realtime generation, storage, and media services.
- XmaxConfiguration
- The credentials, service environment, and logging options for an Xmax client.
- XmaxDownloadedFile
- A downloaded file's local location and byte count.
- XmaxLoggerOption
- The categories of logs emitted by XmaxSDK.
- XmaxRealtimeDualVideo
- A Flutter widget that overlays local and remote video tracks and switches between them.
- XmaxRealtimeManaging
- An interface for local media, realtime connections, and video generation.
- XmaxRealtimeVideo
- A Flutter widget displaying a single local or remote video track.
- XmaxSDKInfo
- Build information for XmaxSDK.
- XmaxStorageCancellationToken
- A one-shot cancellation signal for image and video uploads or downloads.
- XmaxStorageManaging
- An interface for uploading and downloading media files.
- XmaxStorageProgress
- The transferred byte counts and completion fraction for a file operation.
- XmaxUploadedFile
- A stored object's access URL, key, and optional ETag.
Enums
- CameraPosition
- The position of a device camera.
- RealtimeCameraPreset
- A camera resolution preset whose availability depends on the selected model.
- RealtimeConnectionState
- A realtime connection lifecycle state.
- RealtimeExternalAudioSampleFormat
- Interleaved, little-endian PCM sample representations.
- RealtimeExternalVideoPixelFormat
- Pixel layouts accepted by an external video source.
- RealtimeMediaSource
- A local media source supported by XmaxSDK.
- RealtimeModel
- A realtime generation model supported by XmaxSDK.
- RealtimeNetworkQualityLevel
- A network quality measurement for an uplink or downlink RTC connection.
- RealtimePerformanceStatus
- A performance limitation or recovery state for realtime media transport.
- RealtimeQualityLevel
- A realtime transport level, from highest quality at L1 to lower bandwidth at L5.
- RealtimeVideoEncoderPreference
- The encoding preference for realtime video.
- VideoContentMode
- The scaling and cropping mode for video in a view.
- XmaxEnvironment
- The Xmax service environment.
- XmaxErrorCode
- An error code reported by XmaxSDK.
Typedefs
- DownlinkVideoStatisticsListener = void Function(DownlinkVideoStatistics? statistics)
- A listener receiving downlink statistics for the current result stream.
-
RealtimeMediaFrameListener
= FutureOr<
void> Function(RealtimeMediaFrame frame) - Receives remote media serially on the manager's isolate.
- RealtimeNetworkQualityListener = void Function(RealtimeNetworkQuality quality)
- A listener receiving uplink and downlink quality from one sample.
- RealtimePerformanceAlarmListener = void Function(RealtimePerformanceAlarm alarm)
- A listener receiving performance status and any suggested format.
- RealtimeStateListener = void Function(RealtimeState state)
- A listener receiving realtime lifecycle snapshots.
- UplinkVideoStatisticsListener = void Function(UplinkVideoStatistics? statistics)
- Receives local uplink video statistics.
- XmaxStorageProgressHandler = void Function(XmaxStorageProgress progress)
- A callback receiving immutable file transfer progress.
Exceptions / Errors
- XmaxError
- An error thrown or delivered by XmaxSDK.