frames

Subpackages

• protobufs
  • Submodules
    • frames_pb2

Submodules

• frames
  • format_pts()
  • Frame
    • Frame.id
    • Frame.name
    • Frame.pts
    • Frame.broadcast_sibling_id
    • Frame.metadata
    • Frame.transport_source
    • Frame.transport_destination
  • SystemFrame
  • DataFrame
  • ControlFrame
  • UninterruptibleFrame
  • AudioRawFrame
    • AudioRawFrame.audio
    • AudioRawFrame.sample_rate
    • AudioRawFrame.num_channels
    • AudioRawFrame.num_frames
  • ImageRawFrame
    • ImageRawFrame.image
    • ImageRawFrame.size
    • ImageRawFrame.format
  • OutputAudioRawFrame
  • OutputImageRawFrame
    • OutputImageRawFrame.sync_with_audio
  • TTSAudioRawFrame
    • TTSAudioRawFrame.context_id
  • SpeechOutputAudioRawFrame
  • URLImageRawFrame
    • URLImageRawFrame.url
  • SpriteFrame
    • SpriteFrame.images
  • TextFrame
    • TextFrame.text
    • TextFrame.skip_tts
    • TextFrame.includes_inter_frame_spaces
    • TextFrame.append_to_context
  • LLMTextFrame
  • AggregatedTextFrame
    • AggregatedTextFrame.aggregated_by
    • AggregatedTextFrame.context_id
  • VisionTextFrame
  • TTSTextFrame
    • TTSTextFrame.context_id
  • TranscriptionFrame
    • TranscriptionFrame.user_id
    • TranscriptionFrame.timestamp
    • TranscriptionFrame.language
    • TranscriptionFrame.result
    • TranscriptionFrame.finalized
  • InterimTranscriptionFrame
    • InterimTranscriptionFrame.text
    • InterimTranscriptionFrame.user_id
    • InterimTranscriptionFrame.timestamp
    • InterimTranscriptionFrame.language
    • InterimTranscriptionFrame.result
  • TranslationFrame
    • TranslationFrame.user_id
    • TranslationFrame.timestamp
    • TranslationFrame.language
  • LLMContextAssistantTimestampFrame
    • LLMContextAssistantTimestampFrame.timestamp
  • LLMContextFrame
    • LLMContextFrame.context
  • LLMThoughtStartFrame
    • LLMThoughtStartFrame.append_to_context
    • LLMThoughtStartFrame.llm
  • LLMThoughtTextFrame
    • LLMThoughtTextFrame.text
    • LLMThoughtTextFrame.includes_inter_frame_spaces
  • LLMThoughtEndFrame
    • LLMThoughtEndFrame.signature
  • LLMRunFrame
  • LLMMessagesAppendFrame
    • LLMMessagesAppendFrame.messages
    • LLMMessagesAppendFrame.run_llm
  • LLMMessagesUpdateFrame
    • LLMMessagesUpdateFrame.messages
    • LLMMessagesUpdateFrame.run_llm
  • LLMMessagesTransformFrame
    • LLMMessagesTransformFrame.transform
    • LLMMessagesTransformFrame.run_llm
  • LLMSetToolsFrame
    • LLMSetToolsFrame.tools
  • LLMSetToolChoiceFrame
    • LLMSetToolChoiceFrame.tool_choice
  • LLMEnablePromptCachingFrame
    • LLMEnablePromptCachingFrame.enable
  • LLMConfigureOutputFrame
    • LLMConfigureOutputFrame.skip_tts
  • FunctionCallResultProperties
    • FunctionCallResultProperties.run_llm
    • FunctionCallResultProperties.on_context_updated
    • FunctionCallResultProperties.is_final
  • FunctionCallResultFrame
    • FunctionCallResultFrame.function_name
    • FunctionCallResultFrame.tool_call_id
    • FunctionCallResultFrame.arguments
    • FunctionCallResultFrame.result
    • FunctionCallResultFrame.run_llm
    • FunctionCallResultFrame.properties
  • TTSSpeakFrame
    • TTSSpeakFrame.text
    • TTSSpeakFrame.append_to_context
  • OutputTransportMessageFrame
    • OutputTransportMessageFrame.message
  • DTMFFrame
  • OutputDTMFFrame
    • OutputDTMFFrame.button
    • OutputDTMFFrame.buttons
    • OutputDTMFFrame.from_string()
    • OutputDTMFFrame.to_string()
  • StartFrame
    • StartFrame.audio_in_sample_rate
    • StartFrame.audio_out_sample_rate
    • StartFrame.enable_metrics
    • StartFrame.enable_tracing
    • StartFrame.enable_usage_metrics
    • StartFrame.report_only_initial_ttfb
    • StartFrame.tracing_context
  • CancelFrame
    • CancelFrame.reason
  • ErrorFrame
    • ErrorFrame.error
    • ErrorFrame.fatal
    • ErrorFrame.processor
    • ErrorFrame.exception
  • FatalErrorFrame
    • FatalErrorFrame.fatal
  • FrameProcessorPauseUrgentFrame
    • FrameProcessorPauseUrgentFrame.processor
  • FrameProcessorResumeUrgentFrame
    • FrameProcessorResumeUrgentFrame.processor
  • InterruptionFrame
  • UserStartedSpeakingFrame
  • UserStoppedSpeakingFrame
  • UserMuteStartedFrame
  • UserMuteStoppedFrame
  • UserSpeakingFrame
  • VADUserStartedSpeakingFrame
    • VADUserStartedSpeakingFrame.start_secs
    • VADUserStartedSpeakingFrame.timestamp
  • VADUserStoppedSpeakingFrame
    • VADUserStoppedSpeakingFrame.stop_secs
    • VADUserStoppedSpeakingFrame.timestamp
  • BotStartedSpeakingFrame
  • BotStoppedSpeakingFrame
  • BotSpeakingFrame
  • MetricsFrame
    • MetricsFrame.data
  • FunctionCallFromLLM
    • FunctionCallFromLLM.function_name
    • FunctionCallFromLLM.tool_call_id
    • FunctionCallFromLLM.arguments
    • FunctionCallFromLLM.context
  • FunctionCallsStartedFrame
    • FunctionCallsStartedFrame.function_calls
  • FunctionCallCancelFrame
    • FunctionCallCancelFrame.function_name
    • FunctionCallCancelFrame.tool_call_id
  • STTMuteFrame
    • STTMuteFrame.mute
  • InputTransportMessageFrame
    • InputTransportMessageFrame.message
  • OutputTransportMessageUrgentFrame
    • OutputTransportMessageUrgentFrame.message
  • UserImageRequestFrame
    • UserImageRequestFrame.user_id
    • UserImageRequestFrame.text
    • UserImageRequestFrame.append_to_context
    • UserImageRequestFrame.video_source
    • UserImageRequestFrame.function_name
    • UserImageRequestFrame.tool_call_id
    • UserImageRequestFrame.result_callback
  • InputAudioRawFrame
  • InputImageRawFrame
  • InputTextRawFrame
  • UserAudioRawFrame
    • UserAudioRawFrame.user_id
  • UserImageRawFrame
    • UserImageRawFrame.user_id
    • UserImageRawFrame.text
    • UserImageRawFrame.append_to_context
    • UserImageRawFrame.request
  • AssistantImageRawFrame
    • AssistantImageRawFrame.original_data
    • AssistantImageRawFrame.original_mime_type
  • InputDTMFFrame
    • InputDTMFFrame.button
  • OutputDTMFUrgentFrame
    • OutputDTMFUrgentFrame.button
    • OutputDTMFUrgentFrame.buttons
    • OutputDTMFUrgentFrame.from_string()
    • OutputDTMFUrgentFrame.to_string()
  • SpeechControlParamsFrame
    • SpeechControlParamsFrame.vad_params
    • SpeechControlParamsFrame.turn_params
  • ServiceMetadataFrame
    • ServiceMetadataFrame.service_name
  • STTMetadataFrame
    • STTMetadataFrame.ttfs_p99_latency
  • ServiceSwitcherRequestMetadataFrame
    • ServiceSwitcherRequestMetadataFrame.service
  • TaskFrame
  • TaskSystemFrame
  • EndTaskFrame
    • EndTaskFrame.reason
  • StopTaskFrame
  • CancelTaskFrame
    • CancelTaskFrame.reason
  • InterruptionTaskFrame
  • EndFrame
    • EndFrame.reason
  • StopFrame
  • BotConnectedFrame
  • ClientConnectedFrame
  • OutputTransportReadyFrame
  • HeartbeatFrame
    • HeartbeatFrame.timestamp
  • FrameProcessorPauseFrame
    • FrameProcessorPauseFrame.processor
  • FrameProcessorResumeFrame
    • FrameProcessorResumeFrame.processor
  • LLMFullResponseStartFrame
    • LLMFullResponseStartFrame.skip_tts
  • LLMFullResponseEndFrame
    • LLMFullResponseEndFrame.skip_tts
  • LLMAssistantPushAggregationFrame
  • LLMSummarizeContextFrame
    • LLMSummarizeContextFrame.config
  • LLMContextSummaryRequestFrame
    • LLMContextSummaryRequestFrame.request_id
    • LLMContextSummaryRequestFrame.context
    • LLMContextSummaryRequestFrame.min_messages_to_keep
    • LLMContextSummaryRequestFrame.target_context_tokens
    • LLMContextSummaryRequestFrame.summarization_prompt
    • LLMContextSummaryRequestFrame.summarization_timeout
  • LLMContextSummaryResultFrame
    • LLMContextSummaryResultFrame.request_id
    • LLMContextSummaryResultFrame.summary
    • LLMContextSummaryResultFrame.last_summarized_index
    • LLMContextSummaryResultFrame.error
  • FunctionCallInProgressFrame
    • FunctionCallInProgressFrame.function_name
    • FunctionCallInProgressFrame.tool_call_id
    • FunctionCallInProgressFrame.arguments
    • FunctionCallInProgressFrame.cancel_on_interruption
    • FunctionCallInProgressFrame.group_id
  • VisionFullResponseStartFrame
  • VisionFullResponseEndFrame
  • TTSStartedFrame
    • TTSStartedFrame.context_id
  • TTSStoppedFrame
    • TTSStoppedFrame.context_id
  • ServiceUpdateSettingsFrame
    • ServiceUpdateSettingsFrame.settings
    • ServiceUpdateSettingsFrame.delta
    • ServiceUpdateSettingsFrame.service
  • LLMUpdateSettingsFrame
  • TTSUpdateSettingsFrame
  • STTUpdateSettingsFrame
  • UserIdleTimeoutUpdateFrame
    • UserIdleTimeoutUpdateFrame.timeout
  • VADParamsUpdateFrame
    • VADParamsUpdateFrame.params
  • FilterControlFrame
  • FilterUpdateSettingsFrame
    • FilterUpdateSettingsFrame.settings
  • FilterEnableFrame
    • FilterEnableFrame.enable
  • MixerControlFrame
  • MixerUpdateSettingsFrame
    • MixerUpdateSettingsFrame.settings
  • MixerEnableFrame
    • MixerEnableFrame.enable
  • ServiceSwitcherFrame
  • ManuallySwitchServiceFrame
    • ManuallySwitchServiceFrame.service