silicondust

Interface HDHRPrimeProtocol

@Protocol(charset="UTF-8")
 @ApplicationPath(value="http://{host}:{port}/")
public interface HDHRPrimeProtocol

SiliconDust HD Homerun Prime (CableCard) HTTP client protocol.

Version:

$Revision: 5999 $

Author:

Allen D. Ball

Method Summary

Modifier and Type	Method and Description
default List<LineupEntry>	getLineup(String host) SiliconDust HD Homerun Prime (CableCard) line-up request.
List<LineupEntry>	getLineup(String host, Integer port) SiliconDust HD Homerun Prime (CableCard) line-up request.
HttpResponse	getLineup(String host, Integer port, String show, String type) SiliconDust HD Homerun Prime (CableCard) line-up request.
default HttpResponse	getLineup(String host, String show) SiliconDust HD Homerun Prime (CableCard) line-up request (providing results in JSON).
default HttpResponse	stream(String host, Integer tuner, Integer channel, Integer duration) SiliconDust HD Homerun Prime (CableCard) stream ("record") request (auto-select tuner).
HttpResponse	stream(String host, Integer port, String tuner, String channel, Integer duration) SiliconDust HD Homerun Prime (CableCard) stream ("record") request.

Method Detail

getLineup

@GET
 @Path(value="lineup.{type}")
HttpResponse getLineup(@PathParam(value="")
                                                          String host,
                                                          @PathParam(value="")
                                                          Integer port,
                                                          @QueryParam(value="")
                                                          String show,
                                                          @PathParam(value="")
                                                          String type)
                                                   throws HttpResponseException,
                                                          ClientProtocolException,
                                                          IOException

SiliconDust HD Homerun Prime (CableCard) line-up request.

Parameters:

host - The host IP or name.

port - The port.

show - What to show.

type - The type of output.

Returns:

The HttpResponse containing the line-up.

Throws:

IOException - See ProtocolClient.

HttpResponseException - See ProtocolClient.

ClientProtocolException - See ProtocolClient.

getLineup

default HttpResponse getLineup(String host,
                               String show)
                        throws HttpResponseException,
                               ClientProtocolException,
                               IOException

SiliconDust HD Homerun Prime (CableCard) line-up request (providing results in JSON).

Parameters:

host - The host IP or name.

show - What to show.

Returns:

The HttpResponse containing the line-up.

Throws:

IOException - See ProtocolClient.

HttpResponseException - See ProtocolClient.

ClientProtocolException - See ProtocolClient.

getLineup

@GET
 @Path(value="lineup.json")
List<LineupEntry> getLineup(@PathParam(value="")
                                                             String host,
                                                             @PathParam(value="")
                                                             Integer port)
                                                      throws HttpResponseException,
                                                             ClientProtocolException,
                                                             IOException

SiliconDust HD Homerun Prime (CableCard) line-up request.

Parameters:

host - The host IP or name.

port - The port.

Returns:

The HttpResponse containing the line-up.

Throws:

IOException - See ProtocolClient.

HttpResponseException - See ProtocolClient.

ClientProtocolException - See ProtocolClient.

getLineup

default List<LineupEntry> getLineup(String host)
                             throws HttpResponseException,
                                    ClientProtocolException,
                                    IOException

SiliconDust HD Homerun Prime (CableCard) line-up request.

Parameters:

host - The host IP or name.

Returns:

The HttpResponse containing the line-up.

Throws:

IOException - See ProtocolClient.

HttpResponseException - See ProtocolClient.

ClientProtocolException - See ProtocolClient.

stream

@GET
 @Path(value="{tuner}/{channel}")
HttpResponse stream(@PathParam(value="")
                                                           String host,
                                                           @PathParam(value="")
                                                           Integer port,
                                                           @PathParam(value="")
                                                           String tuner,
                                                           @PathParam(value="")
                                                           String channel,
                                                           @QueryParam(value="")
                                                           Integer duration)
                                                    throws HttpResponseException,
                                                           ClientProtocolException,
                                                           IOException

SiliconDust HD Homerun Prime (CableCard) stream ("record") request.

Parameters:

host - The host IP or name.

port - The port.

tuner - The tuner to use.

channel - The channel to tune.

duration - The time to stream in seconds.

Returns:

The HttpResponse containing the stream.

Throws:

IOException - See ProtocolClient.

HttpResponseException - See ProtocolClient.

ClientProtocolException - See ProtocolClient.

stream

default HttpResponse stream(String host,
                            Integer tuner,
                            Integer channel,
                            Integer duration)
                     throws HttpResponseException,
                            ClientProtocolException,
                            IOException

SiliconDust HD Homerun Prime (CableCard) stream ("record") request (auto-select tuner).

Parameters:

host - The host IP or name.

tuner - The tuner to use (may be null).

channel - The channel to tune.

duration - The time to stream in seconds.

Returns:

The HttpResponse containing the stream.

Throws:

IOException - See ProtocolClient.

HttpResponseException - See ProtocolClient.

ClientProtocolException - See ProtocolClient.