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 to be used in next authentication request from client.

}}}

----

=== 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.

challenge        bin  optional   32 bytes of random challenge to be used in next authentication request from client.

                                 Always present if 'noaccess' is set. This is supplied so the client does not have

                                 to issue an extra 'getChallenge' request.

}}}

----

=== setAsync ===

Switch the session into asynchronous mode.

When a session is in this mode the client will get continuous updates from the server about channels and tags.

This also includes creation and deletion of channels and tags. 

An interactive application that presents the user with information about channels and tags would probably want to switch to this mode.

Request message fields:

{{{

None

}}}

Reply message fields:

{{{

None

}}}

----

=== 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 ===

A new channel has been created on the server.

This message is only sent if session is in asynchronous mode.

Message fields:

{{{

channelId        int   required   ID of channel.

channelName      str   required   Name of channel.

channelIcon      str   required   URL to an icon representative for the channel.

eventId          int   optional   ID of the current (or next to be) event on this channel.

tags             str[] optional   Tags this channel is mapped to.

}}}

---

=== channelUpdate ===

A channel has been updated on the server. All fields will be sent even if they are not changed. Most clients can process this and the 'channelAdd' message

with the very same code.

This message is only sent if session is in asynchronous mode.

Message fields:

{{{

channelId        int   required   ID of channel.

channelName      str   required   Name of channel.

channelIcon      str   optioanl   URL to an icon representative for the channel.

eventId          int   optional   ID of the current (or next to be) event on this channel.

tags             str[] required   Tags this channel is mapped to.

}}}

---

=== channelDelete ===

A channel has been deleted on the server.

This message is only sent if session is in asynchronous mode.

Message fields:

{{{

channelId        int   required   ID of channel.

}}}

---

=== tagAdd ===

A new tag has been created on the server.

This message is only sent if session is in asynchronous mode.

Message fields:

{{{

tagId            str   required   ID of tag.

tagName          str   required   Name of tag.

tagIcon          str   optional   URL to an icon representative for the channel.

channels         int[] required   Channels this tag is mapped to.

}}}

=== tagUpdate ===

A tag has been updated on the server.

This message is only sent if session is in asynchronous mode.

Message fields:

{{{

tagId            str   required   ID of tag.

tagName          str   required   Name of tag.

tagIcon          str   optional   URL to an icon representative for the channel.

channels         int[] required   Channels this tag is mapped to.

}}}

=== tagDelete ===

A tag has been deleted from the server.

This message is only sent if session is in asynchronous mode.

Message fields:

{{{

tagId            str   required   ID of tag.

}}}

=== subscriptionStart ===

=== subscriptionStop ===

=== subscriptionStatus ===

=== queueStatus ===