# This file was auto-generated by Fern from our API Definition. import typing from ..core.client_wrapper import SyncClientWrapper from .types.text_to_sound_effects_convert_request_output_format import TextToSoundEffectsConvertRequestOutputFormat from ..core.request_options import RequestOptions from ..errors.unprocessable_entity_error import UnprocessableEntityError from ..types.http_validation_error import HttpValidationError from ..core.unchecked_base_model import construct_type from json.decoder import JSONDecodeError from ..core.api_error import ApiError from ..core.client_wrapper import AsyncClientWrapper # this is used as the default value for optional parameters OMIT = typing.cast(typing.Any, ...) class TextToSoundEffectsClient: def __init__(self, *, client_wrapper: SyncClientWrapper): self._client_wrapper = client_wrapper def convert( self, *, text: str, output_format: typing.Optional[TextToSoundEffectsConvertRequestOutputFormat] = None, duration_seconds: typing.Optional[float] = OMIT, prompt_influence: typing.Optional[float] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> typing.Iterator[bytes]: """ Turn text into sound effects for your videos, voice-overs or video games using the most advanced sound effects model in the world. Parameters ---------- text : str The text that will get converted into a sound effect. output_format : typing.Optional[TextToSoundEffectsConvertRequestOutputFormat] Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs. duration_seconds : typing.Optional[float] The duration of the sound which will be generated in seconds. Must be at least 0.5 and at most 22. If set to None we will guess the optimal duration using the prompt. Defaults to None. prompt_influence : typing.Optional[float] A higher prompt influence makes your generation follow the prompt more closely while also making generations less variable. Must be a value between 0 and 1. Defaults to 0.3. request_options : typing.Optional[RequestOptions] Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response. Yields ------ typing.Iterator[bytes] The generated sound effect as an MP3 file Examples -------- from elevenlabs import ElevenLabs client = ElevenLabs( api_key="YOUR_API_KEY", ) client.text_to_sound_effects.convert( text="Spacious braam suitable for high-impact movie trailer moments", ) """ with self._client_wrapper.httpx_client.stream( "v1/sound-generation", method="POST", params={ "output_format": output_format, }, json={ "text": text, "duration_seconds": duration_seconds, "prompt_influence": prompt_influence, }, headers={ "content-type": "application/json", }, request_options=request_options, omit=OMIT, ) as _response: try: if 200 <= _response.status_code < 300: _chunk_size = request_options.get("chunk_size", 1024) if request_options is not None else 1024 for _chunk in _response.iter_bytes(chunk_size=_chunk_size): yield _chunk return _response.read() if _response.status_code == 422: raise UnprocessableEntityError( typing.cast( HttpValidationError, construct_type( type_=HttpValidationError, # type: ignore object_=_response.json(), ), ) ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, body=_response.text) raise ApiError(status_code=_response.status_code, body=_response_json) class AsyncTextToSoundEffectsClient: def __init__(self, *, client_wrapper: AsyncClientWrapper): self._client_wrapper = client_wrapper async def convert( self, *, text: str, output_format: typing.Optional[TextToSoundEffectsConvertRequestOutputFormat] = None, duration_seconds: typing.Optional[float] = OMIT, prompt_influence: typing.Optional[float] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> typing.AsyncIterator[bytes]: """ Turn text into sound effects for your videos, voice-overs or video games using the most advanced sound effects model in the world. Parameters ---------- text : str The text that will get converted into a sound effect. output_format : typing.Optional[TextToSoundEffectsConvertRequestOutputFormat] Output format of the generated audio. Formatted as codec_sample_rate_bitrate. So an mp3 with 22.05kHz sample rate at 32kbs is represented as mp3_22050_32. MP3 with 192kbps bitrate requires you to be subscribed to Creator tier or above. PCM with 44.1kHz sample rate requires you to be subscribed to Pro tier or above. Note that the μ-law format (sometimes written mu-law, often approximated as u-law) is commonly used for Twilio audio inputs. duration_seconds : typing.Optional[float] The duration of the sound which will be generated in seconds. Must be at least 0.5 and at most 22. If set to None we will guess the optimal duration using the prompt. Defaults to None. prompt_influence : typing.Optional[float] A higher prompt influence makes your generation follow the prompt more closely while also making generations less variable. Must be a value between 0 and 1. Defaults to 0.3. request_options : typing.Optional[RequestOptions] Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response. Yields ------ typing.AsyncIterator[bytes] The generated sound effect as an MP3 file Examples -------- import asyncio from elevenlabs import AsyncElevenLabs client = AsyncElevenLabs( api_key="YOUR_API_KEY", ) async def main() -> None: await client.text_to_sound_effects.convert( text="Spacious braam suitable for high-impact movie trailer moments", ) asyncio.run(main()) """ async with self._client_wrapper.httpx_client.stream( "v1/sound-generation", method="POST", params={ "output_format": output_format, }, json={ "text": text, "duration_seconds": duration_seconds, "prompt_influence": prompt_influence, }, headers={ "content-type": "application/json", }, request_options=request_options, omit=OMIT, ) as _response: try: if 200 <= _response.status_code < 300: _chunk_size = request_options.get("chunk_size", 1024) if request_options is not None else 1024 async for _chunk in _response.aiter_bytes(chunk_size=_chunk_size): yield _chunk return await _response.aread() if _response.status_code == 422: raise UnprocessableEntityError( typing.cast( HttpValidationError, construct_type( type_=HttpValidationError, # type: ignore object_=_response.json(), ), ) ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, body=_response.text) raise ApiError(status_code=_response.status_code, body=_response_json)