java.lang.Object
- nl.harm27.obs.websocket.sender.RequestSender
- - nl.harm27.obs.websocket.sender.SourcesRequestSender

public class SourcesRequestSender
extends RequestSender

Constructor Summary

Constructors
Constructor	Description
`SourcesRequestSender(BiConsumer<BaseRequest,Consumer<BaseResponse>> requestConsumer, Consumer<BaseRequest> batchConsumer, Supplier<String> messageIdSupplier)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`AddFilterToSource.Builder`	`addFilterToSource()`	Add a new filter to a source.
`CreateSource.Builder`	`createSource()`	Create a source and add it as a sceneitem to a scene.
`GetAudioActive.Builder`	`getAudioActive()`	Get the audio's active status of a specified source.
`GetAudioMonitorType.Builder`	`getAudioMonitorType()`	Get the audio monitoring type of the specified source.
`GetAudioTracks.Builder`	`getAudioTracks()`	Gets whether an audio track is active for a source.
`GetBrowserSourceProperties.Builder`	`getBrowserSourceProperties()`	Deprecated. Since 4.8.0.
`GetMediaSourcesList.Builder`	`getMediaSourcesList()`	List the media state of all media sources (vlc and media source)
`GetMute.Builder`	`getMute()`	Get the mute status of a specified source.
`GetSourceActive.Builder`	`getSourceActive()`	Get the source's active status of a specified source (if it is showing in the final mix).
`GetSourceDefaultSettings.Builder`	`getSourceDefaultSettings()`	Get the default settings for a given source type.
`GetSourceFilterInfo.Builder`	`getSourceFilterInfo()`	List filters applied to a source
`GetSourceFilters.Builder`	`getSourceFilters()`	List filters applied to a source
`GetSourceSettings.Builder`	`getSourceSettings()`	Get settings of the specified source
`GetSourcesList.Builder`	`getSourcesList()`	List all sources available in the running OBS instance
`GetSourceTypesList.Builder`	`getSourceTypesList()`	Get a list of all available sources types
`GetSpecialSources.Builder`	`getSpecialSources()`	Get configured special sources like Desktop Audio and Mic/Aux sources.
`GetSyncOffset.Builder`	`getSyncOffset()`	Get the audio sync offset of a specified source.
`GetTextFreetype2Properties.Builder`	`getTextFreetype2Properties()`	Get the current properties of a Text Freetype 2 source.
`GetTextGDIPlusProperties.Builder`	`getTextGDIPlusProperties()`	Get the current properties of a Text GDI Plus source.
`GetVolume.Builder`	`getVolume()`	Get the volume of the specified source.
`MoveSourceFilter.Builder`	`moveSourceFilter()`	Move a filter in the chain (relative positioning)
`RefreshBrowserSource.Builder`	`refreshBrowserSource()`	Refreshes the specified browser source.
`RemoveFilterFromSource.Builder`	`removeFilterFromSource()`	Remove a filter from a source
`ReorderSourceFilter.Builder`	`reorderSourceFilter()`	Move a filter in the chain (absolute index positioning)
`SetAudioMonitorType.Builder`	`setAudioMonitorType()`	Set the audio monitoring type of the specified source.
`SetAudioTracks.Builder`	`setAudioTracks()`	Changes whether an audio track is active for a source.
`SetBrowserSourceProperties.Builder`	`setBrowserSourceProperties()`	Deprecated. Since 4.8.0.
`SetMute.Builder`	`setMute()`	Sets the mute status of a specified source.
`SetSourceFilterSettings.Builder`	`setSourceFilterSettings()`	Update settings of a filter
`SetSourceFilterVisibility.Builder`	`setSourceFilterVisibility()`	Change the visibility/enabled state of a filter
`SetSourceName.Builder`	`setSourceName()`	Note: If the new name already exists as a source, obs-websocket will return an error.
`SetSourceSettings.Builder`	`setSourceSettings()`	Set settings of the specified source.
`SetSyncOffset.Builder`	`setSyncOffset()`	Set the audio sync offset of a specified source.
`SetTextFreetype2Properties.Builder`	`setTextFreetype2Properties()`	Set the current properties of a Text Freetype 2 source.
`SetTextGDIPlusProperties.Builder`	`setTextGDIPlusProperties()`	Set the current properties of a Text GDI Plus source.
`SetVolume.Builder`	`setVolume()`	Set the volume of the specified source.
`TakeSourceScreenshot.Builder`	`takeSourceScreenshot()`	At least `embedPictureFormat` or `saveToFilePath` must be specified.
`ToggleMute.Builder`	`toggleMute()`	Inverts the mute status of a specified source.

Methods inherited from class nl.harm27.obs.websocket.sender.RequestSender
batchMessage, getNewMessageId, sendMessage

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SourcesRequestSender
```
public SourcesRequestSender(BiConsumer<BaseRequest,Consumer<BaseResponse>> requestConsumer,
                            Consumer<BaseRequest> batchConsumer,
                            Supplier<String> messageIdSupplier)
```
- Method Detail
  - getMediaSourcesList
```
public GetMediaSourcesList.Builder getMediaSourcesList()
```
    List the media state of all media sources (vlc and media source)
    
    Since:
    
    4.9.0
    
    See Also:
    
    OBS WebSocket Documentation
  - createSource
```
public CreateSource.Builder createSource()
```
    Create a source and add it as a sceneitem to a scene.
    
    Since:
    
    4.9.0
    
    See Also:
    
    OBS WebSocket Documentation
  - getSourcesList
```
public GetSourcesList.Builder getSourcesList()
```
    List all sources available in the running OBS instance
    
    Since:
    
    4.3.0
    
    See Also:
    
    OBS WebSocket Documentation
  - getSourceTypesList
```
public GetSourceTypesList.Builder getSourceTypesList()
```
    Get a list of all available sources types
    
    Since:
    
    4.3.0
    
    See Also:
    
    OBS WebSocket Documentation
  - getVolume
```
public GetVolume.Builder getVolume()
```
    Get the volume of the specified source. Default response uses mul format, NOT SLIDER PERCENTAGE.
    
    Since:
    
    4.0.0
    
    See Also:
    
    OBS WebSocket Documentation
  - setVolume
```
public SetVolume.Builder setVolume()
```
    Set the volume of the specified source. Default request format uses mul, NOT SLIDER PERCENTAGE.
    
    Since:
    
    4.0.0
    
    See Also:
    
    OBS WebSocket Documentation
  - setAudioTracks
```
public SetAudioTracks.Builder setAudioTracks()
```
    Changes whether an audio track is active for a source.
    
    Since:
    
    4.9.1
    
    See Also:
    
    OBS WebSocket Documentation
  - getAudioTracks
```
public GetAudioTracks.Builder getAudioTracks()
```
    Gets whether an audio track is active for a source.
    
    Since:
    
    4.9.1
    
    See Also:
    
    OBS WebSocket Documentation
  - getMute
```
public GetMute.Builder getMute()
```
    Get the mute status of a specified source.
    
    Since:
    
    4.0.0
    
    See Also:
    
    OBS WebSocket Documentation
  - setMute
```
public SetMute.Builder setMute()
```
    Sets the mute status of a specified source.
    
    Since:
    
    4.0.0
    
    See Also:
    
    OBS WebSocket Documentation
  - toggleMute
```
public ToggleMute.Builder toggleMute()
```
    Inverts the mute status of a specified source.
    
    Since:
    
    4.0.0
    
    See Also:
    
    OBS WebSocket Documentation
  - getSourceActive
```
public GetSourceActive.Builder getSourceActive()
```
    Get the source's active status of a specified source (if it is showing in the final mix).
    
    Since:
    
    4.9.1
    
    See Also:
    
    OBS WebSocket Documentation
  - getAudioActive
```
public GetAudioActive.Builder getAudioActive()
```
    Get the audio's active status of a specified source.
    
    Since:
    
    4.9.0
    
    See Also:
    
    OBS WebSocket Documentation
  - setSourceName
```
public SetSourceName.Builder setSourceName()
```
    Note: If the new name already exists as a source, obs-websocket will return an error.
    
    Since:
    
    4.8.0
    
    See Also:
    
    OBS WebSocket Documentation
  - setSyncOffset
```
public SetSyncOffset.Builder setSyncOffset()
```
    Set the audio sync offset of a specified source.
    
    Since:
    
    4.2.0
    
    See Also:
    
    OBS WebSocket Documentation
  - getSyncOffset
```
public GetSyncOffset.Builder getSyncOffset()
```
    Get the audio sync offset of a specified source.
    
    Since:
    
    4.2.0
    
    See Also:
    
    OBS WebSocket Documentation
  - getSourceSettings
```
public GetSourceSettings.Builder getSourceSettings()
```
    Get settings of the specified source
    
    Since:
    
    4.3.0
    
    See Also:
    
    OBS WebSocket Documentation
  - setSourceSettings
```
public SetSourceSettings.Builder setSourceSettings()
```
    Set settings of the specified source.
    
    Since:
    
    4.3.0
    
    See Also:
    
    OBS WebSocket Documentation
  - getTextGDIPlusProperties
```
public GetTextGDIPlusProperties.Builder getTextGDIPlusProperties()
```
    Get the current properties of a Text GDI Plus source.
    
    Since:
    
    4.1.0
    
    See Also:
    
    OBS WebSocket Documentation
  - setTextGDIPlusProperties
```
public SetTextGDIPlusProperties.Builder setTextGDIPlusProperties()
```
    Set the current properties of a Text GDI Plus source.
    
    Since:
    
    4.1.0
    
    See Also:
    
    OBS WebSocket Documentation
  - getTextFreetype2Properties
```
public GetTextFreetype2Properties.Builder getTextFreetype2Properties()
```
    Get the current properties of a Text Freetype 2 source.
    
    Since:
    
    4.5.0
    
    See Also:
    
    OBS WebSocket Documentation
  - setTextFreetype2Properties
```
public SetTextFreetype2Properties.Builder setTextFreetype2Properties()
```
    Set the current properties of a Text Freetype 2 source.
    
    Since:
    
    4.5.0
    
    See Also:
    
    OBS WebSocket Documentation
  - getBrowserSourceProperties
```
public GetBrowserSourceProperties.Builder getBrowserSourceProperties()
```
    Deprecated.
    Since 4.8.0. Prefer the use of GetSourceSettings. Will be removed in v5.0.0
    
    Get current properties for a Browser Source.
    
    Since:
    
    4.1.0
    
    See Also:
    
    OBS WebSocket Documentation
  - setBrowserSourceProperties
```
public SetBrowserSourceProperties.Builder setBrowserSourceProperties()
```
    Deprecated.
    Since 4.8.0. Prefer the use of SetSourceSettings. Will be removed in v5.0.0
    
    Set current properties for a Browser Source.
    
    Since:
    
    4.1.0
    
    See Also:
    
    OBS WebSocket Documentation
  - getSpecialSources
```
public GetSpecialSources.Builder getSpecialSources()
```
    Get configured special sources like Desktop Audio and Mic/Aux sources.
    
    Since:
    
    4.1.0
    
    See Also:
    
    OBS WebSocket Documentation
  - getSourceFilters
```
public GetSourceFilters.Builder getSourceFilters()
```
    List filters applied to a source
    
    Since:
    
    4.5.0
    
    See Also:
    
    OBS WebSocket Documentation
  - getSourceFilterInfo
```
public GetSourceFilterInfo.Builder getSourceFilterInfo()
```
    List filters applied to a source
    
    Since:
    
    4.7.0
    
    See Also:
    
    OBS WebSocket Documentation
  - addFilterToSource
```
public AddFilterToSource.Builder addFilterToSource()
```
    Add a new filter to a source. Available source types along with their settings properties are available from `GetSourceTypesList`.
    
    Since:
    
    4.5.0
    
    See Also:
    
    OBS WebSocket Documentation
  - removeFilterFromSource
```
public RemoveFilterFromSource.Builder removeFilterFromSource()
```
    Remove a filter from a source
    
    Since:
    
    4.5.0
    
    See Also:
    
    OBS WebSocket Documentation
  - reorderSourceFilter
```
public ReorderSourceFilter.Builder reorderSourceFilter()
```
    Move a filter in the chain (absolute index positioning)
    
    Since:
    
    4.5.0
    
    See Also:
    
    OBS WebSocket Documentation
  - moveSourceFilter
```
public MoveSourceFilter.Builder moveSourceFilter()
```
    Move a filter in the chain (relative positioning)
    
    Since:
    
    4.5.0
    
    See Also:
    
    OBS WebSocket Documentation
  - setSourceFilterSettings
```
public SetSourceFilterSettings.Builder setSourceFilterSettings()
```
    Update settings of a filter
    
    Since:
    
    4.5.0
    
    See Also:
    
    OBS WebSocket Documentation
  - setSourceFilterVisibility
```
public SetSourceFilterVisibility.Builder setSourceFilterVisibility()
```
    Change the visibility/enabled state of a filter
    
    Since:
    
    4.7.0
    
    See Also:
    
    OBS WebSocket Documentation
  - getAudioMonitorType
```
public GetAudioMonitorType.Builder getAudioMonitorType()
```
    Get the audio monitoring type of the specified source.
    
    Since:
    
    4.8.0
    
    See Also:
    
    OBS WebSocket Documentation
  - setAudioMonitorType
```
public SetAudioMonitorType.Builder setAudioMonitorType()
```
    Set the audio monitoring type of the specified source.
    
    Since:
    
    4.8.0
    
    See Also:
    
    OBS WebSocket Documentation
  - getSourceDefaultSettings
```
public GetSourceDefaultSettings.Builder getSourceDefaultSettings()
```
    Get the default settings for a given source type.
    
    Since:
    
    4.9.0
    
    See Also:
    
    OBS WebSocket Documentation
  - takeSourceScreenshot
```
public TakeSourceScreenshot.Builder takeSourceScreenshot()
```
    At least `embedPictureFormat` or `saveToFilePath` must be specified. Clients can specify `width` and `height` parameters to receive scaled pictures. Aspect ratio is preserved if only one of these two parameters is specified.
    
    Since:
    
    4.6.0
    
    See Also:
    
    OBS WebSocket Documentation
  - refreshBrowserSource
```
public RefreshBrowserSource.Builder refreshBrowserSource()
```
    Refreshes the specified browser source.
    
    Since:
    
    4.9.0
    
    See Also:
    
    OBS WebSocket Documentation

Class SourcesRequestSender

Constructor Summary

Method Summary

Methods inherited from class nl.harm27.obs.websocket.sender.RequestSender

Methods inherited from class java.lang.Object

Constructor Detail

SourcesRequestSender

Method Detail

getMediaSourcesList

createSource

getSourcesList

getSourceTypesList

getVolume

setVolume

setAudioTracks

getAudioTracks

getMute

setMute

toggleMute

getSourceActive

getAudioActive

setSourceName

setSyncOffset

getSyncOffset

getSourceSettings

setSourceSettings

getTextGDIPlusProperties

setTextGDIPlusProperties

getTextFreetype2Properties

setTextFreetype2Properties

getBrowserSourceProperties

setBrowserSourceProperties

getSpecialSources

getSourceFilters

getSourceFilterInfo

addFilterToSource

removeFilterFromSource

reorderSourceFilter

moveSourceFilter

setSourceFilterSettings

setSourceFilterVisibility

getAudioMonitorType

setAudioMonitorType

getSourceDefaultSettings

takeSourceScreenshot

refreshBrowserSource