Payload.Stream

AI-generated Key Takeaways

• The Payload.Stream class represents a stream of data.

• You can access the stream data as an InputStream using the asInputStream() method or as a ParcelFileDescriptor using the asParcelFileDescriptor() method.

• The close() method is deprecated and you should use Payload.close() instead.

public static class Payload.Stream extends Object

Represents a stream of data.

Public Method Summary

InputStream	asInputStream() Gets the InputStream from which to read the data for this Stream.
ParcelFileDescriptor	asParcelFileDescriptor() Gets the ParcelFileDescriptor from which to read the data for this Stream.
void	close() This method is deprecated. Use Payload.close() instead.

Inherited Method Summary

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

Public Methods

public InputStream asInputStream ()

Gets the InputStream from which to read the data for this Stream.

When receiving a Payload of type Payload.Type.STREAM, Nearby Connections will continuously write the incoming streamed data to this InputStream; when no more data is available (likely because the sending device stopped streaming data), this InputStream will be closed.

public ParcelFileDescriptor asParcelFileDescriptor ()

Gets the ParcelFileDescriptor from which to read the data for this Stream.

When receiving a Payload of type Payload.Type.STREAM, Nearby Connections will continuously write the incoming streamed data to this ParcelFileDescriptor; when no more data is available (likely because the sending device stopped streaming data), this ParcelFileDescriptor will be closed.

public void close ()

This method is deprecated.
Use Payload.close() instead.

Closes the ParcelFileDescriptor and InputStream to release resource.