1. class
  2. Hypervel
  3. \
  4. Ai
  5. \
  6. Files
  7. \
  8. LocalAudio

LocalAudio

class LocalAudio extends Audio implements Arrayable, JsonSerializable, StorableFile, TranscribableAudio

Traits

CanBeUploadedToProvider
HasLocalContent

Properties

string|null $name from  File
string|null $mime from  File
protected array<string, string>|SerializableClosure $headers from  File
protected array<string, mixed>|SerializableClosure $providerOptions from  File

Methods

static File|null
fromArray(array $data)

Reconstruct a file instance from its array representation.

from  File
static string
value(array $data, string $key, string $type)

Get a required value from the file representation.

from  File
string|null
name()

Get the displayable name of the file.

from  HasLocalContent
HasName
as(string|null $name)

Set the displayable name of the file.

from  File
File
withHeaders(array|Closure $headers)

Specify HTTP headers for the file upload. Closures may only capture serializable values.

from  File
File
withProviderOptions(array|Closure $options)

Specify provider-specific options for the file upload. Closures may only capture serializable values.

from  File
array
providerOptions(Lab|string $provider)

Get the provider-specific options for the file upload.

from  File
array
headers(Lab|string $provider)

Get the HTTP headers for the file upload.

from  File
string|null
mimeType()

Get the file's MIME type.

from  HasLocalContent
File
withMimeType(string $mimeType)

Set the file's MIME type.

from  File
static Base64Audio
fromBase64(string $base64, string|null $mimeType = null)

Create a new audio from Base64 data.

from  Audio
static LocalAudio
fromPath(string $path, string|null $mimeType = null)

Create a new audio using the audio at the given path.

from  Audio
static RemoteAudio
fromUrl(string $url, string|null $mimeType = null)

Create a new remote audio using the audio at the given URL.

from  Audio
static StoredAudio
fromStorage(string $path, string|null $disk = null)

Create a new stored audio using the audio at the given path on the given disk.

from  Audio
static Base64Audio
fromUpload(UploadedFile $file, string|null $mimeType = null)

Create a new Base64 audio using the given file upload.

from  Audio
StoredFileResponse
put(string|null $mimeType = null, string|null $name = null, Provider|Lab|string|null $provider = null)

Store the file on a given provider.

from  CanBeUploadedToProvider
string
content()

Get the raw representation of the file.

from  HasLocalContent
array
jsonSerialize()

Get the JSON serializable representation of the instance.

from  HasLocalContent
string
__toString()

Get the file content as a string.

from  HasLocalContent
__construct(string $path, string|null $mimeType = null)

Create a new local audio file.

PendingTranscriptionGeneration
transcription()

Generate a transcription of the given audio.

array
toArray()

Get the instance as an array.

Details

in File at line 29
static File|null fromArray(array $data)

Reconstruct a file instance from its array representation.

Parameters

array $data

Return Value

File|null

in File at line 70
static protected string value(array $data, string $key, string $type)

Get a required value from the file representation.

Parameters

array $data
string $key
string $type

Return Value

string

in HasLocalContent at line 31
string|null name()

Get the displayable name of the file.

Return Value

string|null

in File at line 90
HasName as(string|null $name)

Set the displayable name of the file.

Parameters

string|null $name

Return Value

HasName

in File at line 102
File withHeaders(array|Closure $headers)

Specify HTTP headers for the file upload. Closures may only capture serializable values.

Parameters

array|Closure $headers

Return Value

File

in File at line 116
File withProviderOptions(array|Closure $options)

Specify provider-specific options for the file upload. Closures may only capture serializable values.

Parameters

array|Closure $options

Return Value

File

in File at line 130
array providerOptions(Lab|string $provider)

Get the provider-specific options for the file upload.

Parameters

Lab|string $provider

Return Value

array

in File at line 142
array headers(Lab|string $provider)

Get the HTTP headers for the file upload.

Parameters

Lab|string $provider

Return Value

array

in HasLocalContent at line 39
string|null mimeType()

Get the file's MIME type.

Return Value

string|null

in File at line 160
File withMimeType(string $mimeType)

Set the file's MIME type.

Parameters

string $mimeType

Return Value

File

in Audio at line 14
static Base64Audio fromBase64(string $base64, string|null $mimeType = null)

Create a new audio from Base64 data.

Parameters

string $base64
string|null $mimeType

Return Value

Base64Audio

in Audio at line 22
static LocalAudio fromPath(string $path, string|null $mimeType = null)

Create a new audio using the audio at the given path.

Parameters

string $path
string|null $mimeType

Return Value

LocalAudio

in Audio at line 30
static RemoteAudio fromUrl(string $url, string|null $mimeType = null)

Create a new remote audio using the audio at the given URL.

Parameters

string $url
string|null $mimeType

Return Value

RemoteAudio

in Audio at line 38
static StoredAudio fromStorage(string $path, string|null $disk = null)

Create a new stored audio using the audio at the given path on the given disk.

Parameters

string $path
string|null $disk

Return Value

StoredAudio

in Audio at line 46
static Base64Audio fromUpload(UploadedFile $file, string|null $mimeType = null)

Create a new Base64 audio using the given file upload.

Parameters

UploadedFile $file
string|null $mimeType

Return Value

Base64Audio

in CanBeUploadedToProvider at line 17
StoredFileResponse put(string|null $mimeType = null, string|null $name = null, Provider|Lab|string|null $provider = null)

Store the file on a given provider.

Parameters

string|null $mimeType
string|null $name
Provider|Lab|string|null $provider

Return Value

StoredFileResponse

in HasLocalContent at line 17
string content()

Get the raw representation of the file.

Return Value

string

Exceptions

RuntimeException

in HasLocalContent at line 47
array jsonSerialize()

Get the JSON serializable representation of the instance.

Return Value

array

in HasLocalContent at line 55
string __toString()

Get the file content as a string.

Return Value

string

at line 25
__construct(string $path, string|null $mimeType = null)

Create a new local audio file.

Parameters

string $path
string|null $mimeType

at line 37
PendingTranscriptionGeneration transcription()

Generate a transcription of the given audio.

Return Value

PendingTranscriptionGeneration

at line 45
array toArray()

Get the instance as an array.

Return Value

array