► caplin.streamlink.StreamLinkFactory()

► <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:

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"
});
 

liberator_urls can alternatively return a function that will return the next Liberator URL to try connecting to, this can be used to dynamically control the Liberator sequence:

 var index = -1;
 var fixedLiberators = ["rttp://liberator1:8080", "rttp://liberator2:8080"];
 caplin.streamlink.StreamLinkFactory.create({
     "liberator_urls": function(){
     	index = (++index) % fixedLiberators.length;
     	return fixedLiberators[index];
     },
    "username": "test@example.com",
    "password": "my password"
});
 

Map

configuration

StreamLink configuration as JSON.

Returns

{caplin.streamlink.StreamLink} A StreamLink object.