# danog\MadelineProto\OggWriter: Async OGG stream writer.

[Back to index](../../index.html)

> Author: Daniil Gentili <daniil@daniil.it>  
  

Async OGG stream writer.  



## Properties
* `$streamId`: `int` 

## Method list:
* [`__construct(\Amp\ByteStream\WritableStream|\danog\MadelineProto\LocalFile $out, ?int $streamId = NULL)`](#__construct)
* [`resume(): bool`](#resume)
* [`writeHeader(int $channels, int $sampleRate, string $opusVersion, (string|null) $opusHead = NULL): void`](#writeHeader)
* [`writeChunk(string $chunk, int $granuleDiff, bool $eos): void`](#writeChunk)

## Methods:
### <a name="__construct"></a> `__construct(\Amp\ByteStream\WritableStream|\danog\MadelineProto\LocalFile $out, ?int $streamId = NULL)`

Write an ogg OPUS file.


Parameters:

* `$out`: `\Amp\ByteStream\WritableStream|\danog\MadelineProto\LocalFile`   
* `$streamId`: `?int`   


#### See also: 
* `\Amp\ByteStream\WritableStream`
* [`\danog\MadelineProto\LocalFile`: Indicates a local file to upload.](../../danog/MadelineProto/LocalFile.html)




### <a name="resume"></a> `resume(): bool`

Reopen the file at its end to continue the stream, after a restart. Returns false if it can't continue (it
was ended, written to a stream, or the file no longer exists): the owner should then start a new one.  



### <a name="writeHeader"></a> `writeHeader(int $channels, int $sampleRate, string $opusVersion, (string|null) $opusHead = NULL): void`

Write the OpusHead and OpusTags header pages.


Parameters:

* `$channels`: `int`   
* `$sampleRate`: `int`   
* `$opusVersion`: `string`   
* `$opusHead`: `(string|null)` A complete OpusHead packet to use verbatim (for a multichannel or
                             pre-existing stream), instead of building a family-0 one from
                             `$channels` and `$sampleRate`.  



### <a name="writeChunk"></a> `writeChunk(string $chunk, int $granuleDiff, bool $eos): void`




Parameters:

* `$chunk`: `string`   
* `$granuleDiff`: `int`   
* `$eos`: `bool`   



---
Generated by [danog/phpdoc](https://phpdoc.daniil.it)