Home | Class Index
Class
caplin.streamlink

StreamLinkFactory

Factory that creates caplin.streamlink.StreamLink instances.

Constructor Summary

Attributes Name and Description
caplin.streamlink.StreamLinkFactory()

Method Summary

Attributes Name and Description
<static> caplin.streamlink.StreamLink create(Map configuration)

Creates a StreamLink object that has the supplied StreamLink configuration settings.

Constructor Detail

► caplin.streamlink.StreamLinkFactory()

Method Detail

► <static> caplin.streamlink.StreamLink create(Map configuration)

Creates a StreamLink object that has the supplied StreamLink configuration settings.

The configuration format is JSON, which can contain the following attributes:
Attribute name Type Default Optional Description
liberator_urls string, [string], [[string]] None No The Liberator URL groups to connect to (see below).
keymaster_url string None (KeyMaster not used) Yes URL of KeyMaster for secure authentication of Liberator login requests.
keymaster_poll_url string None (KeyMaster not used) Yes URL that StreamLink uses to check the connection to KeyMaster every keymaster_poll_interval milliseconds.
keymaster_poll_interval number 600000 milliseconds
(10 minutes)		 Yes Interval in milliseconds at which StreamLink will poll KeyMaster (on keymaster_poll_url) to keep the KeyMaster session open.
keymaster_poll_response_listener KeymasterResponseListener None Yes The implementation of the caplin.streamlink.KeymasterResponseListener interface. This receives information about responses to keep-alive requests made to KeyMaster.
keymaster_token_transport_method string POST Yes WARNING: We strongly recommend that you do not set this attribute to GET for security concerns. This attribute sets the transport method that Keymaster will use to request the Keymaster token, can be set to either GET or POST.
keymaster_token_transport_method_poll string POST Yes WARNING: We strongly recommend that you do not set this attribute to GET for security concerns. This attribute sets the transport method that Keymaster will use to poll the Keymaster token, can be set to either GET or POST.
keymaster_cross_domain_authentication boolean false Yes Enable cross-site (CORS) XMLHttpRequest invocations for keymaster requests. The server must be CORS enabled and include the Access-Control-Allow-Credentials: true http header.
credentials_provider CredentialsProvider None Yes The implementation of the caplin.streamlink.CredentialsProvider interface. This custom Credentials Provider that will be used to send credentials to log into Liberator.
username string None Yes Liberator login user-name to use if logins are not being managed by KeyMaster.
password string None Yes Liberator login password to use if logins are not being managed by KeyMaster.
application_id string None Yes Application identifier. This is useful for tracing purposes and managing licensing requirements.
poll_interval number 1000 milliseconds
(1 second)		 Yes Time interval in milliseconds between polls of the Liberator. This only applies to HTTP polling type connections (see 'RTTP connection types' in the document StreamLink Overview).
disable_polling boolean false Yes Set to true if you don't want to use polling connection when the rttp(s) protocol is specified.
disable_sse_connection boolean false Yes Set to true if you don't want to use server sent events connection when the rttp(s) protocol is specified.
forever_frame_reconnect_count number 10000 Yes After receiving this number of messages, a forever frame connection will perform a fast reconnect to prevent memory leaks.
reconnect_delay number 2000 milliseconds
(2 seconds)		 Yes Delay in milliseconds before retrying, after failing to connect with all available connection options.
request_timeout number 10000 milliseconds
(10 seconds)		 Yes Time in milliseconds allowed for the response to each request before StreamLink reconnects to the Liberator.
http_timeout number 3000 milliseconds
(3 seconds)		 Yes Time in milliseconds allowed for an HTTP Request to finish successfully before StreamLink times out.
http_pad_length number 4096 bytes Yes The amount of padding to use when establishing a streaming connection using the http(s):// connection type. Increasing this value can help should there be a buffering network component between the client and the Liberator.
clock_offset_interval number 10000 milliseconds
(10 seconds)		 Yes StreamLink calculates a new clock offset value every clock_offset_interval millseconds. The clock offset is Liberator time minus StreamLink time; it is a measure of how much the Liberator and client clocks differ and is used in the calculation of latency statistics, such as average latency (see the latency_interval attribute). Also see StatisticsEvent.getClockOffset().
clock_offset_window number 120000 milliseconds
(2 minutes)		 Yes Time in milliseconds a calculated clock offset is valid for use in producing statistics. For the definition of clock offset, see the clock_offset_interval attribute. You should not normally need to change this attribute; if you think it needs to be changed, please contact Caplin Support for advice.
latency_interval number 10000 milliseconds
(10 seconds)		 Yes Time in milliseconds between successive calculations of average latency. Latency is the time taken for a StreamLink heartbeat message to be sent from the Liberator to the client. The shorter the latency_interval, the more accurate are the average latency statistics. However, too small a value can adversely impact performance.
latency_window number 120000 milliseconds
(2 minutes)		 Yes Time in milliseconds for which a calculated latency value is valid for use in producing latency statistics. The shorter the time, the faster changes in average latency will show up in the statistics. However, too small a value can result in the average varying in a way that makes it hard to see trends.
log_window_log_level caplin.streamlink.LogLevel caplin.streamlink.LogLevel.FINE Yes When the debug log window is shown, (see log_window_visible), only messages at or above the log level defined by log_window_log_level appear in the window.
log_window_visible boolean none Yes When true, the debug log window is shown when StreamLink first connects.
When false, the debug log window cannot be shown.
When left undefined the debug window can be shown if the page url contains a fragment of the form ?debug=[LogLevel name].
inactivity_timeout number -1 (disabled) No Set the duration (in milliseconds) that Liberator will use to disconnect this client should no messages have been received from StreamLink
log_buffer_size number -1 (disabled) Yes Sets the number of log lines to be cached in the log buffer.

Failover configuration using liberator_urls.

The liberator_urls configuration attribute defines the Liberator URL groups to connect to in failover situations. A URL group is selected at random and StreamLink tries to connect to the URLs in the group sequentially. If StreamLink fails to connect to any of the URLs in a group, the next group is tried, and so on.

For more information about how to configure a failover strategy for StreamLink, see the "Resilience, failover, and load balancing" section of the StreamLink Overview.

Each URL specified must include the protocol; one of: rttp, rttps, http, https, ws, wss, poll, polls.

  • The protocol rttp means use the best non-ssl supported protocols (in the order: ws, http, poll).
  • The protocol rttps means use the best ssl supported protocols (in the order: wss, https, polls).

Examples:

The following example shows the JSON configuration to connect to a single Liberator instance running on the host liberator1 on port 8080. The credentials to login to the Liberator are specified using the username and password attributes.

caplin.streamlink.StreamLinkFactory.create({
     "liberator_urls": "rttp://liberator1:8080",
     "username": "test@example.com",
     "password": "my password"
});

The following example shows the JSON configuration for failover between two Liberator pairs. The credentials to login to the Liberator are specified using the username and password attributes.

caplin.streamlink.StreamLinkFactory.create({
     "liberator_urls": [
       ["rttp://liberator1:8080", "rttp://liberator2:8080"],
       ["rttp://liberator3:8080", "rttp://liberator4:8080"]
     ],
    "username": "test@example.com",
    "password": "my password"
});

Parameters
Map configuration StreamLink configuration as JSON.
Returns
{caplin.streamlink.StreamLink} A StreamLink object.