Tvheadend

----

= Client to Server methods =

----

=== getChallenge ===

Request a 32 byte challenge used to generate a authentication digest.

Request message fields:

{{{

None

}}}

Reply message fields:

{{{

challenge        bin  required 32 bytes of random challenge. Should be used in next authenticate message.

}}}

----

=== authenticate ===

Request message fields:

{{{

username         str  required Username.

digest           bin  required SHA-1 hash of [password (not including terminating NUL)] + [challenge]

}}}

Reply message fields:

{{{

noaccess         int  optional Set to '1' if access was denied.

}}}

----

=== setMode ===

----

=== getEvent ===

----

=== subscribe ===

Request subscription to the given channel. A request for a subscription is always successful.

When the server is ready to transmit data it will first send a 'subscriptionStart' message.

Request message fields:

{{{

channelId        int  required ID for channel. 

subscriptionId   int  required Subscription ID. Selected by client. This value is not interpreted by the server in any form. 

                               The value is used from now on in all messages related to the subscription.

}}}

Reply message fields:

{{{

None.

}}}

----

=== unsubscribe ===

Stop a subscription.

Attributes

{{{

subscriptionId   int  required Subscription ID.

}}}

Reply message fields:

{{{

None.

}}}

----

= Server to Client methods =

=== channelAdd ===

Only sent if session is in async mode.

=== channelUpdate ===

Only sent if session is in async mode.

=== channelDelete ===

Only sent if session is in async mode.

=== tagAdd ===

Only sent if session is in async mode.

=== tagUpdate ===

Only sent if session is in async mode.

=== tagDelete ===

Only sent if session is in async mode.

=== subscriptionStart ===

=== subscriptionStop ===

=== subscriptionStatus ===

=== queueStatus ===