To create new wiki account, please join us on #znc at freenode and ask admins to create a wiki account for you. You can say thanks to spambots for this inconvenience.

Difference between revisions of "Playback"

From ZNC
Jump to: navigation, search
(Commands)
Line 2: Line 2:
 
{{ambox | type = delete | text = '''This external module is a work in progress.'''<br/><small>Please note that it requires the latest development version of ZNC.<br/>Contact the author if you have any questions, but feel free to ask on IRC, someone might able to help you there, too.</small>}}
 
{{ambox | type = delete | text = '''This external module is a work in progress.'''<br/><small>Please note that it requires the latest development version of ZNC.<br/>Contact the author if you have any questions, but feel free to ask on IRC, someone might able to help you there, too.</small>}}
  
The advanced playback module makes it possible for IRC clients to avoid undesired repetitive buffer playback. IRC clients may request the module to send a partial buffer playback starting from a certain point of time.
+
The advanced playback module makes it possible for IRC clients to avoid undesired repetitive buffer playback. IRC clients may request the module to send a partial buffer playback starting from and ending to a certain point of time.
  
The source code and more detailed documentation is available on [https://github.com/jpnurmi/znc-playback GitHub]. See also instructions for [[compiling modules]].
+
The source code is available on [https://github.com/jpnurmi/znc-playback GitHub]. See also instructions for [[compiling modules]].
  
== Usage ==
+
{{Module arguments|no}}
 +
 
 +
=== Persistent Buffers ===
 +
The module has been designed to be used together with persistent buffers. Either uncheck Auto Clear Chan Buffer and Auto Clear Query Buffer (Your Settings -> Flags) via [[webadmin]] or disable <code>AutoClearChanBuffer</code> and <code>AutoClearQueryBuffer</code> via [[controlpanel]].
 +
 
 +
=== Message tags ===
 +
The module implementation is based on the IRC v3.2 message tags [1] and server time [2] extensions. The module injects a server time tag (in millisecond precision) to each message sent from ZNC to an IRC client that has requested the <code>znc.in/playback</code> capability.
 +
 
 +
* [1] http://ircv3.org/specification/message-tags-3.2
 +
* [2] http://ircv3.org/extensions/server-time-3.2
 +
 
 +
=== Usage ===
 +
In order for an IRC client to support advanced playback, it should request
 +
the <code>znc.in/playback</code> capability and keep track of the latest server time
 +
of received messages. The syntax for a buffer playback request is:
 +
 
 +
    /msg *playback PLAY <buffer(s)> [from] [to]
 +
 
 +
Where the first argument is a comma-separated list of channels (supports
 +
wildcards), and optional last two arguments are number of seconds (floating
 +
point for millisecond precision) elapsed since January 1, 1970.
 +
 
 +
When a client connects to ZNC, it may request the module to play all
 +
buffers, starting from *0* (first connect) or the the timestamp of the
 +
latest received message (consecutive reconnects).
 +
 
 +
    /msg *playback PLAY * 0
 +
 
 +
It is also possible to selectively clear playback buffers using the
 +
following command syntax:
 +
 
 +
    /msg *playback CLEAR <buffer(s)>
 +
 
 +
If a client wants to list available buffers, it can use the following
 +
command syntax:
 +
 
 +
    /msg *playback LIST [buffer(s)]
 +
 
 +
The module outputs a list of available/matching buffers, one per line,
 +
each followed by the first and last timestamp for the respective buffer.
 +
 
 +
See also [[query buffers]].
 +
 
 +
=== Limits ===
  
{{Module arguments|no}}
+
The module also allows configuring client specific buffer limits for
 +
identified clients, using the following command syntax:
 +
 
 +
    /msg *playback LIMIT <client> [limit]
 +
 
 +
A limit of less or equal to 0 clears the limit. Notice that the limit
 +
cannot exceed the limit set in the ZNC configuration, but can be used
 +
to limit the playback for eg. mobile clients.
 +
 
 +
=== Client identifiers ===
  
=== Commands ===
+
ZNC supports passing a client identifier in the password:
Play matching buffers:
 
/msg *playback PLAY <buffer(s)> [from] [to]
 
  
Clear matching buffers:
+
    username@identifier/network:password
/msg *playback CLEAR <buffer(s)>
 
  
List available/matching buffers:
+
or in the username:
/msg *playback LIST [buffer(s)]
 
  
Client specific buffer limit:
+
    username@identifier/network
/msg *playback LIMIT <client> [limit]
 
  
== Supported clients ==
+
=== Supported clients ===
  
 
* [http://textualapp.com Textual IRC client] (Mac OS X)
 
* [http://textualapp.com Textual IRC client] (Mac OS X)
Line 30: Line 77:
 
* [https://github.com/communi/communi-sailfish Communi for SailfishOS]
 
* [https://github.com/communi/communi-sailfish Communi for SailfishOS]
  
== Open tickets ==
+
=== Open tickets ===
 
* [https://hexchat.github.io HexChat] (https://github.com/hexchat/hexchat/issues/1109)
 
* [https://hexchat.github.io HexChat] (https://github.com/hexchat/hexchat/issues/1109)
 
* [https://play.google.com/store/apps/details?id=com.fusionx.lightirc&hl=en HoloIRC] (https://github.com/tilal6991/HoloIRC/issues/92)
 
* [https://play.google.com/store/apps/details?id=com.fusionx.lightirc&hl=en HoloIRC] (https://github.com/tilal6991/HoloIRC/issues/92)

Revision as of 17:45, 5 February 2015

The advanced playback module makes it possible for IRC clients to avoid undesired repetitive buffer playback. IRC clients may request the module to send a partial buffer playback starting from and ending to a certain point of time.

The source code is available on GitHub. See also instructions for compiling modules.

Arguments

This user module takes no arguments.

Read loading modules to learn more about loading modules.

Persistent Buffers

The module has been designed to be used together with persistent buffers. Either uncheck Auto Clear Chan Buffer and Auto Clear Query Buffer (Your Settings -> Flags) via webadmin or disable AutoClearChanBuffer and AutoClearQueryBuffer via controlpanel.

Message tags

The module implementation is based on the IRC v3.2 message tags [1] and server time [2] extensions. The module injects a server time tag (in millisecond precision) to each message sent from ZNC to an IRC client that has requested the znc.in/playback capability.

Usage

In order for an IRC client to support advanced playback, it should request the znc.in/playback capability and keep track of the latest server time of received messages. The syntax for a buffer playback request is:

   /msg *playback PLAY <buffer(s)> [from] [to]

Where the first argument is a comma-separated list of channels (supports wildcards), and optional last two arguments are number of seconds (floating point for millisecond precision) elapsed since January 1, 1970.

When a client connects to ZNC, it may request the module to play all buffers, starting from *0* (first connect) or the the timestamp of the latest received message (consecutive reconnects).

   /msg *playback PLAY * 0

It is also possible to selectively clear playback buffers using the following command syntax:

   /msg *playback CLEAR <buffer(s)>

If a client wants to list available buffers, it can use the following command syntax:

   /msg *playback LIST [buffer(s)]

The module outputs a list of available/matching buffers, one per line, each followed by the first and last timestamp for the respective buffer.

See also query buffers.

Limits

The module also allows configuring client specific buffer limits for identified clients, using the following command syntax:

   /msg *playback LIMIT <client> [limit]

A limit of less or equal to 0 clears the limit. Notice that the limit cannot exceed the limit set in the ZNC configuration, but can be used to limit the playback for eg. mobile clients.

Client identifiers

ZNC supports passing a client identifier in the password:

   username@identifier/network:password

or in the username:

   username@identifier/network

Supported clients

Open tickets