Home | Class Index
Class
caplin.streamlink

ThrottleCommand

Enumeration that defines the available throttle levels and throttle commands.

A ThrottleCommand is passed as a parameter to the throttleSubject() and throttleEverything() methods of caplin.streamlink.StreamLink.

For an explanation of throttling, refer the Throttling section of the document StreamLink Overview.

Constructor Summary

Attributes Name and Description
caplin.streamlink.ThrottleCommand()

Field Summary

Attributes Name and Description
<static> caplin.streamlink.ThrottleCommand.DEF

*

Set the throttle level to the default level.
<static> caplin.streamlink.ThrottleCommand.DOWN

*

Decrease the throttle level.
<static> caplin.streamlink.ThrottleCommand.MAX

*

Set the throttle level to the maximum amount of throttling.
<static> caplin.streamlink.ThrottleCommand.MIN

*

Set the throttle level to the minimum amount of throttling.
<static> caplin.streamlink.ThrottleCommand.START

*

Start sending updates to the client again.
<static> caplin.streamlink.ThrottleCommand.STOP

*

Stop sending updates to the client.
<static> caplin.streamlink.ThrottleCommand.UP

*

Increase the throttle level.

Constructor Detail

► caplin.streamlink.ThrottleCommand()

Field Detail

► <static> caplin.streamlink.ThrottleCommand.DEF

*

Set the throttle level to the default level.

► <static> caplin.streamlink.ThrottleCommand.DOWN

*

Decrease the throttle level.

► <static> caplin.streamlink.ThrottleCommand.MAX

*

Set the throttle level to the maximum amount of throttling.

► <static> caplin.streamlink.ThrottleCommand.MIN

*

Set the throttle level to the minimum amount of throttling.

► <static> caplin.streamlink.ThrottleCommand.START

*

Start sending updates to the client again.

► <static> caplin.streamlink.ThrottleCommand.STOP

*

Stop sending updates to the client.

► <static> caplin.streamlink.ThrottleCommand.UP

*

Increase the throttle level.