Main Content

getOptions

Get server options

Since R2023a

collapse all in page

    Syntax

    options = getOptions(clientObj)

    Description

    options = getOptions(clientObj) returns the server options for the speechClient object.

    example

    Examples

    collapse all

    Open Live Script

    Create a speechClient object that interfaces with the Google speech service.

    clientObj = speechClient("Google");

    Set the languageCode server option for speech-to-text transcription.

    setOptions(clientObj,"languageCode","en-US");

    Use getOptions to view the server options in the speechClient object.

    options = getOptions(clientObj)
    options=1×2 cell array
    {'languageCode'}    {["en-US"]}

    Use clearOptions to remove the server option from the speechClient object.

    clearOptions(clientObj)

    Input Arguments

    collapse all

    Client object, specified as an object returned by speechClient. Server options are only valid for client objects that interface with third-party speech services (Google®, IBM®, Microsoft®, or Amazon®).

    Output Arguments

    collapse all

    Server options, returned as a cell array of name-value pairs in the format {Name1,Value1,...,NameN,ValueN}, where Name is the server option name and Value is the value of the option. See the documentation for the third-party speech service for information about valid server options.

    Version History

    Introduced in R2023a

    See Also

    | |