X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsonitus%2Fdata%2FFilter.java;h=924ccee678fdeda36bc30ee123b2978919a9ef15;hb=eacf380129e247dd03f7d054d67e34cb43658959;hp=ec8fb94d74da19e6305f63e78760a543341af3e4;hpb=633a841142f978235ed9f745b6ba16c278963e62;p=sonitus.git

diff --git a/src/main/java/net/pterodactylus/sonitus/data/Filter.java b/src/main/java/net/pterodactylus/sonitus/data/Filter.java
index ec8fb94..924ccee 100644
--- a/src/main/java/net/pterodactylus/sonitus/data/Filter.java
+++ b/src/main/java/net/pterodactylus/sonitus/data/Filter.java
@@ -66,7 +66,7 @@ public interface Filter {
 	Metadata metadata();
 
 	/**
-	 * Notifies the sink that the metadata of the audio stream has changed. This
+	 * Notifies the filter that the metadata of the audio stream has changed. This
 	 * method should return as fast as possible, i.e. every heavy lifting should be
 	 * done from another thread.
 	 *
@@ -80,16 +80,18 @@ public interface Filter {
 	 *
 	 * @param bufferSize
 	 * 		The maximum amount of bytes to retrieve from the audio stream
-	 * @return A buffer filled with up to {@code bufferSize} bytes of data; the
+	 * @return A data packet containing the metadata of the stream (optional) and
+	 *         the buffer filled with up to {@code bufferSize} bytes of data; the
 	 *         returned buffer may contain less data than requested but will not
-	 *         contain excess elements
+	 *         contain excess elements (i.e. it can be smaller than the requested
+	 *         size)
 	 * @throws IOException
 	 * 		if an I/O error occurs
 	 */
-	byte[] get(int bufferSize) throws IOException;
+	DataPacket get(int bufferSize) throws IOException;
 
 	/**
-	 * Opens this sink using the format parameters of the given metadata.
+	 * Opens this filter using the format parameters of the given metadata.
 	 *
 	 * @param metadata
 	 * 		The metadata of the stream
@@ -98,17 +100,17 @@ public interface Filter {
 	 */
 	void open(Metadata metadata) throws IOException;
 
-	/** Closes this sink. */
+	/** Closes this filter. */
 	void close();
 
 	/**
-	 * Processes the given buffer of data.
+	 * Processes the given data packet.
 	 *
-	 * @param buffer
+	 * @param dataPacket
 	 * 		The data to process
 	 * @throws IOException
 	 * 		if an I/O error occurs
 	 */
-	void process(byte[] buffer) throws IOException;
+	void process(DataPacket dataPacket) throws IOException;
 
 }