Caplin Systems - StreamLinkJS API Documentation

caplin
- streamlink
  - alerts
    - Notification
    - NotificationListener
    - NotificationService
    - ResultListener
    - Trigger
    - TriggerListener
    - TriggerService
    - TriggerState
  - Channel
  - ChannelListener
  - ChatEvent
  - ChatEventType
  - CommandErrorEvent
  - CommandErrorType
  - CommandListener
  - CommandResultEvent
  - CommandResultListener
  - CommandSubscription
  - ConnectionListener
  - ConnectionState
  - ConnectionStatusEvent
  - ConsoleLogListener
  - ContainerElement
  - ContainerEvent
  - ContainerFilterFactory
  - ContainerModel
  - DataEvent
  - DirectoryChangeElement
  - DirectoryEvent
  - ErrorReason
  - FilterExpression
  - FilterExpressionLogicalOperator
  - FilterExpressionOperator
  - JsonChannel
  - JsonChannelListener
  - JsonDiscardHandler
  - JsonEvent
  - JsonHandler
  - JsonProvider
  - JsonProviderHandle
  - JsonPublisher
  - KeymasterCookieProvider
  - KeymasterHttpHeaderProvider
  - KeymasterPollResponseListener
  - LiberatorUrlProvider
  - Logger
  - LoginFailedReason
  - LogInfo
  - LogLevel
  - LogListener
  - NewsEvent
  - PageElement
  - PageEvent
  - PayloadType
  - PermissionEvent
  - Publisher
  - RecordDiscardHandler
  - RecordProvider
  - RecordProviderHandle
  - RecordPublisher
  - RecordType1Event
  - RecordType2Event
  - RecordType3Event
  - ServiceStatus
  - ServiceStatusEvent
  - SourceStatus
  - SourceStatusEvent
  - StatisticsEvent
  - StoryEvent
  - StreamLink
  - StreamLinkFactory
  - SubjectType
  - Subscription
  - SubscriptionErrorEvent
  - SubscriptionErrorType
  - SubscriptionListener
  - SubscriptionStatusEvent
  - SubscriptionStatusType
  - ThrottleCommand
  - WebRequestParameters

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.