Skip to main content

Overview

APIDescription
overwolf.streaming.enums.CaptureErrorCode-
overwolf.streaming.enums.eVideoBaseFrameSizeSource-
overwolf.streaming.enums.eVideoFrameSizeCalcMethod-
overwolf.streaming.enums.IndicationPosition-
overwolf.streaming.enums.IndicationType-
overwolf.streaming.enums.ObsStreamingMode-
overwolf.streaming.enums.StreamEncoder-
overwolf.streaming.enums.StreamEncoderPreset_AMD_AMF-
overwolf.streaming.enums.StreamEncoderPreset_Intel-
overwolf.streaming.enums.StreamEncoderPreset_NVIDIA-
overwolf.streaming.enums.StreamEncoderPreset_x264-
overwolf.streaming.enums.StreamEncoderRateControl_AMD_AMF-
overwolf.streaming.enums.StreamEncoderRateControl_NVIDIA-
overwolf.streaming.enums.StreamEncoderRateControl_x264-
overwolf.streaming.enums.StreamingMode-
overwolf.streaming.enums.StreamingProvider-
overwolf.streaming.enums.StreamMouseCursor-
overwolf.streaming.changeVolumeChanges the volume of the stream.
overwolf.streaming.getActiveRecordingAppsvoid
overwolf.streaming.getAudioDevicesReturns an array of all audio devices that can be used.
overwolf.streaming.getCapabilitiesvoid
overwolf.streaming.getStreamEncodersReturns an array of supported streaming encoders, with extra metadata for each one.
overwolf.streaming.getWatermarkSettingsGets the watermark settings.
overwolf.streaming.getWindowStreamingModeCall the given callback function with the window's streaming mode as a parameter.
overwolf.streaming.setBRBImageSet a stream's Be Right Back image.
overwolf.streaming.setWatermarkSettingsSets the watermark settings.
overwolf.streaming.setWindowObsStreamingModeSets the streaming mode for the window when using OBS.
overwolf.streaming.setWindowStreamingModeSet the window's stream mode.
overwolf.streaming.splitRequest to split video now.
overwolf.streaming.startStart a new stream.
overwolf.streaming.stopStops the given stream.
overwolf.streaming.updateStreamingDesktopOptionsUpdate stream desktop capture options.
overwolf.streaming.ActiveRecordingApps-
overwolf.streaming.AudioDeviceData-
overwolf.streaming.EncoderData-
overwolf.streaming.GameAudioDeviceDefines game volume and enablement settings.
overwolf.streaming.GameCaptureOptions-
overwolf.streaming.GameWindowCaptureGame window capture options.
overwolf.streaming.GetActiveRecordingAppsResult-
overwolf.streaming.GetAudioDevicesResult-
overwolf.streaming.GetStreamEncodersResult-
overwolf.streaming.GetWatermarkSettingsResult-
overwolf.streaming.GetWindowStreamingModeResultStream settings container.
overwolf.streaming.SplitResult-
overwolf.streaming.StartCaptureResult-
overwolf.streaming.StopStreamingEvent-
overwolf.streaming.StopStreamingResult-
overwolf.streaming.StreamAudioOptionsStream audio options.
overwolf.streaming.StreamAuthParamsStream authorization data.
overwolf.streaming.StreamDesktopCaptureOptionsStream desktop capture options.
overwolf.streaming.StreamDeviceVolumeDefines a device volume and enablement settings.
overwolf.streaming.StreamEvent-
overwolf.streaming.StreamInfo-
overwolf.streaming.StreamingCapabilities-
overwolf.streaming.StreamIngestServerInformation on the server that is being streamed to.
overwolf.streaming.StreamingSourceImageChangedEvent-
overwolf.streaming.StreamingVideoEncoderAMD_AMFSettingsDefines the configuration for the AMD AMF encoder.
overwolf.streaming.StreamingVideoEncoderIntelSettingsDefines the configuration for an Intel encoder.
overwolf.streaming.StreamingVideoEncoderNVIDIA_NVENCSettingsDefines the configuration for the NVIDIA NVENC encoder.
overwolf.streaming.StreamingVideoEncoderSettingsDefines the video encoder settings.
overwolf.streaming.StreamingVideoEncoderx264SettingsDefines the configuration for an x264 encoder.
overwolf.streaming.StreamParamsRepresents the settings required to start a stream.
overwolf.streaming.StreamPeripheralsCaptureOptionsStream capture options for peripheral devices.
overwolf.streaming.StreamQuotaParamsBasic quota information
overwolf.streaming.StreamResult-
overwolf.streaming.StreamSettingsStream settings container.
overwolf.streaming.StreamVideoOptionsStream video options.
overwolf.streaming.SupportedEncodersUpdatedEvent-
overwolf.streaming.VideoFileSplitedEvent-
overwolf.streaming.WatermarkSettingsA settings container for a stream Overwolf watermark settings.
overwolf.streaming.onErrorTriggered when an error occurs, sent with an error code.
overwolf.streaming.onStartStreamingFired when the stream has stopped.
overwolf.streaming.onStopStreamingFired when the stream has stopped.
overwolf.streaming.onStreamingErrorFired upon an error with the stream.
overwolf.streaming.onStreamingSourceImageChangedFired when the stream started streaming a new image source (desktop, game).
overwolf.streaming.onStreamingWarningFired upon a warning with the stream.
overwolf.streaming.onVideoFileSplitedFired upon video file splited.