Caplin Systems - StreamLinkJS API Documentation

Home | Class Index

caplin
- streamlink
  - alerts
    - Notification
    - NotificationListener
    - NotificationService
    - ResultListener
    - Trigger
    - TriggerListener
    - TriggerService
    - TriggerState
  - Channel
  - ChannelListener
  - ChatEvent
  - ChatEventType
  - CommandErrorEvent
  - CommandErrorType
  - CommandListener
  - CommandSubscription
  - ConnectionListener
  - ConnectionState
  - ConnectionStatusEvent
  - ConsoleLogListener
  - ContainerElement
  - ContainerEvent
  - ContainerFilterFactory
  - ContainerModel
  - DataEvent
  - DirectoryChangeElement
  - DirectoryEvent
  - ErrorReason
  - FilterExpression
  - FilterExpressionLogicalOperator
  - FilterExpressionOperator
  - KeymasterPollResponseListener
  - Logger
  - LoginFailedReason
  - LogInfo
  - LogLevel
  - LogListener
  - NewsEvent
  - PageElement
  - PageEvent
  - PermissionEvent
  - RecordType1Event
  - RecordType2Event
  - RecordType3Event
  - ServiceStatus
  - ServiceStatusEvent
  - SourceStatus
  - SourceStatusEvent
  - StatisticsEvent
  - StoryEvent
  - StreamLink
  - StreamLinkFactory
  - SubjectType
  - Subscription
  - SubscriptionErrorEvent
  - SubscriptionErrorType
  - SubscriptionListener
  - SubscriptionStatusEvent
  - SubscriptionStatusType
  - ThrottleCommand
  - WebRequestParameters

Class

caplin.streamlink

ServiceStatus

Enumeration that defines the status of a Service.

The ServiceStatus will be provided by calling getServiceStatus on a caplin.streamlink.ServiceStatusEvent.

The three states that are possible for a Liberator data service are:

OK - All of the data sources that make up the service are up.
Down - One or more required data sources for the service are down.
Limited - One or more non-required data sources for the service are down.

Constructor Summary

Attributes	Name and Description
	`caplin.streamlink.ServiceStatus()`

Field Summary

Attributes Name and Description

Attributes	Name and Description
`<static>`	`caplin.streamlink.ServiceStatus.DOWN` Indicates that a service is down, which means that at least one of the required sources defined for the service are down.
`<static>`	`caplin.streamlink.ServiceStatus.LIMITED` Indicates that a service is limited, which means that at least one of the non required sources defined for the service are down (but all of the required sources are up).
`<static>`	`caplin.streamlink.ServiceStatus.OK` Indicates that the service is OK, which means that all the required and non required sources defined for the service are up.

<static>

caplin.streamlink.ServiceStatus.DOWN

Indicates that a service is down, which means that at least one of the required sources defined for the service are down.

<static>

caplin.streamlink.ServiceStatus.LIMITED

Indicates that a service is limited, which means that at least one of the non required sources defined for the service are down (but all of the required sources are up).

<static>

caplin.streamlink.ServiceStatus.OK

Indicates that the service is OK, which means that all the required and non required sources defined for the service are up.

Constructor Detail

► caplin.streamlink.ServiceStatus()

See: caplin.streamlink.ServiceStatusEvent

Field Detail

► <static> caplin.streamlink.ServiceStatus.DOWN

Indicates that a service is down, which means that at least one of the required sources defined for the service are down.

► <static> caplin.streamlink.ServiceStatus.LIMITED

Indicates that a service is limited, which means that at least one of the non required sources defined for the service are down (but all of the required sources are up).

► <static> caplin.streamlink.ServiceStatus.OK

Indicates that the service is OK, which means that all the required and non required sources defined for the service are up.