pr comments

Author: oliviamiller

src/viam/components/audio_input/audio_input.py

@@ -15,7 +15,8 @@
 
 
 class AudioInput(ComponentBase, StreamSource[Audio]):
-    """AudioInput represents a component that can capture audio.
+    """ DEPRECATED: AudioInput is deprecated, use AudioIn instead
+    AudioInput represents a component that can capture audio.
 
     This acts as an abstract base class for any drivers representing specific
     audio input implementations. This cannot be used on its own. If the ``__init__()`` function is

src/viam/components/audio_input/client.py

@@ -1,4 +1,5 @@
 from typing import Any, AsyncIterator, Dict, List, Mapping, Optional, Union
+import warnings
 
 from grpclib.client import Channel
 
@@ -21,10 +22,17 @@
 
 class AudioInputClient(AudioInput, ReconfigurableResourceRPCClientBase):
     """
+    DEPRECATED: AudioInput is deprecated, use AudioIn instead.
     gRPC client for the AudioInput component.
     """
 
     def __init__(self, name: str, channel: Channel):
+        warnings.warn(
+            "AudioInputClient is deprecated and will be removed in a future release. "
+            "Use AudioIn instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         self.channel = channel
         self.client = AudioInputServiceStub(channel)
         super().__init__(name)

src/viam/components/audio_input/service.py

@@ -1,4 +1,5 @@
 import wave
+import warnings
 from datetime import timedelta
 from io import BytesIO
 
@@ -25,9 +26,19 @@
 
 class AudioInputRPCService(AudioInputServiceBase, ResourceRPCServiceBase[AudioInput]):
     """
+    DEPRECATED: AudioInput is deprecated, use AudioIn instead.
     gRPC Service for a generic AudioInput
     """
 
+    def __init__(self, *args, **kwargs):
+        warnings.warn(
+            "AudioInput is deprecated and will be removed in a future release. "
+            "Use AudioIn instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        super().__init__(*args, **kwargs)
+
     RESOURCE_TYPE = AudioInput
 
     async def Chunks(self, stream: Stream[ChunksRequest, ChunksResponse]) -> None:

src/viam/media/audio.py

@@ -1,4 +1,5 @@
 from dataclasses import dataclass
+from enum import Enum
 
 from viam.proto.component.audioinput import AudioChunk, AudioChunkInfo
 from viam.streams import Stream, StreamReader
@@ -14,3 +15,29 @@ class Audio:
 
 AudioReader = StreamReader[Audio]
 AudioStream = Stream[Audio]
+
+class AudioCodec(str, Enum):
+    """Common audio codec identifiers.
+
+    These constants represent commonly supported audio codecs
+    for audioin and audioout components.
+
+    Example::
+
+        from viam.components.codecs import AudioCodec
+        from viam.proto.common import AudioInfo
+
+        audio_info = AudioInfo(
+            codec=AudioCodec.PCM16,
+            sample_rate_hz=44100,
+            num_channels=2
+        )
+    """
+
+    PCM16 = "pcm16"
+    PCM32 = "pcm32"
+    PCM32_FLOAT = "pcm32float"
+    MP3 = "mp3"
+    AAC = "aac"
+    OPUS = "opus"
+    FLAC = "flac"