Package nl.harm27.obs.websocket.api.requests.streaming

Class StartStreaming.Stream

java.lang.Object

nl.harm27.obs.websocket.api.requests.streaming.StartStreaming.Stream

Enclosing class:

StartStreaming

public class StartStreaming.Stream
extends Object

Constructor Summary

Constructors

Constructor	Description
Stream()

Method Summary

Modifier and Type	Method	Description
Optional<Object>	getMetadata()	Adds the given object parameters as encoded query string parameters to the 'key' of the RTMP stream.
Optional<StartStreaming.Settings>	getSettings()	Settings for the stream.
Optional<String>	getType()	If specified ensures the type of stream matches the given type (usually 'rtmp_custom' or 'rtmp_common').
void	setMetadata(Object metadata)	Adds the given object parameters as encoded query string parameters to the 'key' of the RTMP stream.
void	setSettings(StartStreaming.Settings settings)	Settings for the stream.
void	setType(String type)	If specified ensures the type of stream matches the given type (usually 'rtmp_custom' or 'rtmp_common').

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Stream

public Stream()

Method Detail

getType

public Optional<String> getType()

If specified ensures the type of stream matches the given type (usually 'rtmp_custom' or 'rtmp_common'). If the currently configured stream type does not match the given stream type, all settings must be specified in the `settings` object or an error will occur when starting the stream.

setType

public void setType(String type)

If specified ensures the type of stream matches the given type (usually 'rtmp_custom' or 'rtmp_common'). If the currently configured stream type does not match the given stream type, all settings must be specified in the `settings` object or an error will occur when starting the stream.

getMetadata

public Optional<Object> getMetadata()

Adds the given object parameters as encoded query string parameters to the 'key' of the RTMP stream. Used to pass data to the RTMP service about the streaming. May be any String, Numeric, or Boolean field.

setMetadata

public void setMetadata(Object metadata)

Adds the given object parameters as encoded query string parameters to the 'key' of the RTMP stream. Used to pass data to the RTMP service about the streaming. May be any String, Numeric, or Boolean field.

getSettings

public Optional<StartStreaming.Settings> getSettings()

Settings for the stream.

setSettings

public void setSettings(StartStreaming.Settings settings)

Settings for the stream.