silicondust

Class HDHRTuner

java.lang.Object

silicondust.HDHRTuner

public class HDHRTuner
extends Object

SiliconDust HDHomeRun tuner.

Version:

$Revision: 5999 $

Author:

Allen D. Ball

Constructor Summary

Constructors

Constructor and Description
HDHRTuner(InetAddress address) Sole public constructor.

Method Summary

Modifier and Type	Method and Description
void	channel(int tuner, int key, int channel) Method to tune the specified tuner,
void	channel(int tuner, int key, int channel, int program) Method to tune the specified tuner,
void	channel(int tuner, int key, String channel) Method to tune the specified tuner,
void	channel(int tuner, int key, String channel, int program) Method to tune the specified tuner,
String	channelmap(int tuner, int key) Method to get the /tuner<n>/channelmap value on the specified tuner,
void	channelmap(int tuner, int key, String string) Method to specify the /tuner<n>/channelmap on the specified tuner,
static Map<Integer,HDHRTuner>	discover() Static method to determine the HDHomeRun tuners on the network.
String	get(int key, String name) Method to get an option value from this HDHRTuner.
HDHRPrimeClient	getClient()
int	getCount()
Map<String,Set<String>>	getFeature()
int	getID()
InetAddress	getInetAddress()
List<LineupEntry>	getLineup()
String	getModel()
URI	getURI()
int	lock(int tuner) Method to obtain a lock on a tuner.
InetAddress	locker(int tuner, int key) Method to get a tuner lock owner.
SortedSet<String>	options() Method to get the configuration options supported by this HDHRTuner.
void	program(int tuner, int key, int program) Method to tune the specified tuner,
List<HDHRProgram>	scan() Method to scan the first tuner available and return a List of HDHRPrograms found.
List<HDHRProgram>	scan(int tuner, int key) Method to scan the specified tuner and return a List of HDHRPrograms found.
void	set(int key, String name, String value, String... pairs) Method to set an option value for this HDHRTuner.
void	target(int tuner, int key, URI locator) Method to set the tuner target,
String	toString()
void	unlock(int tuner, int key) Method to unlock a tuner.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

HDHRTuner

public HDHRTuner(InetAddress address)

Sole public constructor.

Parameters:

address - The InetAddress.

Method Detail

discover

public static Map<Integer,HDHRTuner> discover()

Static method to determine the HDHomeRun tuners on the network.

Returns:

The Map of IDs and HDHRTuners.

getID

public int getID()

Returns:

Tuner ID

getCount

public int getCount()

Returns:

Tuner Count

getInetAddress

public InetAddress getInetAddress()

Returns:

Tuner InetAddress

getURI

public URI getURI()

Returns:

Tuner URI

getModel

public String getModel()

Returns:

Tuner /sys/hwmodel

getFeature

public Map<String,Set<String>> getFeature()

Returns:

Tuner /sys/features

getClient

public HDHRPrimeClient getClient()

Returns:

HDHRPrimeClient

getLineup

public List<LineupEntry> getLineup()

Returns:

HDHRPrimeClient.getLineup()

lock

public int lock(int tuner)
         throws IOException

Method to obtain a lock on a tuner.

Parameters:

tuner - The tuner number.

Returns:

The lock key value.

Throws:

IOException - If the tuner cannot be locked.

unlock

public void unlock(int tuner,
                   int key)
            throws IOException

Method to unlock a tuner.

Parameters:

tuner - The tuner number.

key - The key value.

Throws:

IOException - If the tuner cannot be unlocked.

locker

public InetAddress locker(int tuner,
                          int key)
                   throws IOException

Method to get a tuner lock owner.

Parameters:

tuner - The tuner number.

key - The key value.

Returns:

The InetAddress of the owner (or null if there is none).

Throws:

IOException - If the tuner locker cannot be determined.

get

public String get(int key,
                  String name)
           throws IOException

Method to get an option value from this HDHRTuner.

Parameters:

key - The tuner lockkey (if set).

name - The option name.

Returns:

The option value.

Throws:

IOException - If the option cannot be retrieved.

set

public void set(int key,
                String name,
                String value,
                String... pairs)
         throws IOException

Method to set an option value for this HDHRTuner.

Parameters:

key - The tuner lockkey (if set).

name - The option name.

value - The option value.

pairs - Optional name/value pairs.

Throws:

IOException - If the option(s) cannot be set.

options

public SortedSet<String> options()
                          throws IOException

Method to get the configuration options supported by this HDHRTuner.

Returns:

The SortedSet of options.

Throws:

IOException - If the options cannot be retrieved.

scan

public List<HDHRProgram> scan()
                       throws IOException

Method to scan the first tuner available and return a List of HDHRPrograms found.

Returns:

The List of HDHRPrograms found.

Throws:

IOException - If the HDHRPrograms cannot be retrieved.

scan

public List<HDHRProgram> scan(int tuner,
                              int key)
                       throws IOException

Method to scan the specified tuner and return a List of HDHRPrograms found.

Parameters:

tuner - The tuner to scan.

key - The key value.

Returns:

The List of HDHRPrograms found.

Throws:

IOException - If the HDHRPrograms cannot be retrieved.

channelmap

public String channelmap(int tuner,
                         int key)
                  throws IOException

Method to get the /tuner<n>/channelmap value on the specified tuner,

Parameters:

tuner - The tuner to scan.

key - The key value.

Returns:

The value of the /tuner<n>/channelmap.

Throws:

IOException - If the channel map name cannot be retrieved.

channelmap

public void channelmap(int tuner,
                       int key,
                       String string)
                throws IOException

Method to specify the /tuner<n>/channelmap on the specified tuner,

Parameters:

tuner - The tuner to scan.

key - The key value.

string - The name of the /tuner<n>/channelmap.

Throws:

IOException - If the channel map name cannot be specified.

channel

public void channel(int tuner,
                    int key,
                    String channel,
                    int program)
             throws IOException

Method to tune the specified tuner,

Parameters:

tuner - The tuner to scan.

key - The key value.

channel - The channel specification (number or frequency with optional modulation).

program - The program (subchannel) specification.

Throws:

IOException - If the tuner cannot be tuned.

See Also:

channel(int,int,String), program(int,int,int)

channel

public void channel(int tuner,
                    int key,
                    int channel,
                    int program)
             throws IOException

Method to tune the specified tuner,

Parameters:

tuner - The tuner to scan.

key - The key value.

channel - The channel specification (number or frequency).

program - The program (subchannel) specification.

Throws:

IOException - If the tuner cannot be tuned.

See Also:

channel(int,int,int), program(int,int,int)

channel

public void channel(int tuner,
                    int key,
                    String channel)
             throws IOException

Method to tune the specified tuner,

Parameters:

tuner - The tuner to scan.

key - The key value.

channel - The channel specification (number or frequency with optional modulation).

Throws:

IOException - If the tuner cannot be tuned.

channel

public void channel(int tuner,
                    int key,
                    int channel)
             throws IOException

Method to tune the specified tuner,

Parameters:

tuner - The tuner to scan.

key - The key value.

channel - The channel specification (number or frequency).

Throws:

IOException - If the tuner cannot be tuned.

program

public void program(int tuner,
                    int key,
                    int program)
             throws IOException

Method to tune the specified tuner,

Parameters:

tuner - The tuner to scan.

key - The key value.

program - The program (subchannel) specification.

Throws:

IOException - If the tuner cannot be tuned.

target

public void target(int tuner,
                   int key,
                   URI locator)
            throws IOException

Method to set the tuner target,

Parameters:

tuner - The tuner to scan.

key - The key value.

locator - The target URI.

Throws:

IOException - If the tuner target cannot be set.

toString

public String toString()

Overrides:

toString in class Object