diff --git a/stream-video-android-core/api/stream-video-android-core.api b/stream-video-android-core/api/stream-video-android-core.api index b578f52c023..1c28747b7f6 100644 --- a/stream-video-android-core/api/stream-video-android-core.api +++ b/stream-video-android-core/api/stream-video-android-core.api @@ -60,6 +60,7 @@ public abstract interface class io/getstream/android/video/generated/apis/Produc public abstract fun rejectCall (Ljava/lang/String;Ljava/lang/String;Lio/getstream/android/video/generated/models/RejectCallRequest;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; public abstract fun rejectCall (Ljava/lang/String;Ljava/lang/String;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; public abstract fun reportClientCallEvent (Lio/getstream/android/video/generated/models/ReportClientEventRequest;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public abstract fun reportHLSStats (Ljava/lang/String;Ljava/lang/String;Lio/getstream/android/video/generated/models/ReportHLSStatsRequest;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; public abstract fun requestPermission (Ljava/lang/String;Ljava/lang/String;Lio/getstream/android/video/generated/models/RequestPermissionRequest;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; public abstract fun resolveSipAuth (Lio/getstream/android/video/generated/models/ResolveSipAuthRequest;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; public abstract fun resolveSipInbound (Lio/getstream/android/video/generated/models/ResolveSipInboundRequest;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; @@ -4970,6 +4971,70 @@ public final class io/getstream/android/video/generated/models/GroupedStatsRespo public fun toString ()Ljava/lang/String; } +public final class io/getstream/android/video/generated/models/HLSPlaybackStats { + public fun (JIJJLjava/lang/Integer;Ljava/lang/Integer;Ljava/lang/Integer;Ljava/lang/Integer;Ljava/lang/Integer;Ljava/lang/Integer;)V + public synthetic fun (JIJJLjava/lang/Integer;Ljava/lang/Integer;Ljava/lang/Integer;Ljava/lang/Integer;Ljava/lang/Integer;Ljava/lang/Integer;ILkotlin/jvm/internal/DefaultConstructorMarker;)V + public final fun component1 ()J + public final fun component10 ()Ljava/lang/Integer; + public final fun component2 ()I + public final fun component3 ()J + public final fun component4 ()J + public final fun component5 ()Ljava/lang/Integer; + public final fun component6 ()Ljava/lang/Integer; + public final fun component7 ()Ljava/lang/Integer; + public final fun component8 ()Ljava/lang/Integer; + public final fun component9 ()Ljava/lang/Integer; + public final fun copy (JIJJLjava/lang/Integer;Ljava/lang/Integer;Ljava/lang/Integer;Ljava/lang/Integer;Ljava/lang/Integer;Ljava/lang/Integer;)Lio/getstream/android/video/generated/models/HLSPlaybackStats; + public static synthetic fun copy$default (Lio/getstream/android/video/generated/models/HLSPlaybackStats;JIJJLjava/lang/Integer;Ljava/lang/Integer;Ljava/lang/Integer;Ljava/lang/Integer;Ljava/lang/Integer;Ljava/lang/Integer;ILjava/lang/Object;)Lio/getstream/android/video/generated/models/HLSPlaybackStats; + public fun equals (Ljava/lang/Object;)Z + public final fun getBitrateKbps ()Ljava/lang/Integer; + public final fun getBufferLengthMs ()Ljava/lang/Integer; + public final fun getDroppedFrames ()Ljava/lang/Integer; + public final fun getHeight ()Ljava/lang/Integer; + public final fun getLiveLatencyMs ()Ljava/lang/Integer; + public final fun getMaxStallDurationMs ()J + public final fun getStallCount ()I + public final fun getStallDurationMs ()J + public final fun getWatchDurationMs ()J + public final fun getWidth ()Ljava/lang/Integer; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + +public final class io/getstream/android/video/generated/models/HLSPlaybackStatsJsonAdapter : com/squareup/moshi/JsonAdapter { + public fun (Lcom/squareup/moshi/Moshi;)V + public fun fromJson (Lcom/squareup/moshi/JsonReader;)Lio/getstream/android/video/generated/models/HLSPlaybackStats; + public synthetic fun fromJson (Lcom/squareup/moshi/JsonReader;)Ljava/lang/Object; + public fun toJson (Lcom/squareup/moshi/JsonWriter;Lio/getstream/android/video/generated/models/HLSPlaybackStats;)V + public synthetic fun toJson (Lcom/squareup/moshi/JsonWriter;Ljava/lang/Object;)V + public fun toString ()Ljava/lang/String; +} + +public final class io/getstream/android/video/generated/models/HLSPlayerEvent { + public fun (Ljava/lang/String;JLjava/util/Map;)V + public synthetic fun (Ljava/lang/String;JLjava/util/Map;ILkotlin/jvm/internal/DefaultConstructorMarker;)V + public final fun component1 ()Ljava/lang/String; + public final fun component2 ()J + public final fun component3 ()Ljava/util/Map; + public final fun copy (Ljava/lang/String;JLjava/util/Map;)Lio/getstream/android/video/generated/models/HLSPlayerEvent; + public static synthetic fun copy$default (Lio/getstream/android/video/generated/models/HLSPlayerEvent;Ljava/lang/String;JLjava/util/Map;ILjava/lang/Object;)Lio/getstream/android/video/generated/models/HLSPlayerEvent; + public fun equals (Ljava/lang/Object;)Z + public final fun getData ()Ljava/util/Map; + public final fun getTimestamp ()J + public final fun getType ()Ljava/lang/String; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + +public final class io/getstream/android/video/generated/models/HLSPlayerEventJsonAdapter : com/squareup/moshi/JsonAdapter { + public fun (Lcom/squareup/moshi/Moshi;)V + public fun fromJson (Lcom/squareup/moshi/JsonReader;)Lio/getstream/android/video/generated/models/HLSPlayerEvent; + public synthetic fun fromJson (Lcom/squareup/moshi/JsonReader;)Ljava/lang/Object; + public fun toJson (Lcom/squareup/moshi/JsonWriter;Lio/getstream/android/video/generated/models/HLSPlayerEvent;)V + public synthetic fun toJson (Lcom/squareup/moshi/JsonWriter;Ljava/lang/Object;)V + public fun toString ()Ljava/lang/String; +} + public final class io/getstream/android/video/generated/models/HLSSettingsRequest { public fun ()V public fun (Ljava/util/List;Ljava/lang/Boolean;Ljava/lang/Boolean;)V @@ -5697,13 +5762,14 @@ public final class io/getstream/android/video/generated/models/IngressVideoLayer } public final class io/getstream/android/video/generated/models/JoinCallRequest { - public fun (Ljava/lang/String;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Integer;Ljava/lang/String;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/util/List;Lio/getstream/android/video/generated/models/CallRequest;Lio/getstream/android/video/generated/models/JoinCallRequest$Prefer;Ljava/util/List;)V - public synthetic fun (Ljava/lang/String;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Integer;Ljava/lang/String;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/util/List;Lio/getstream/android/video/generated/models/CallRequest;Lio/getstream/android/video/generated/models/JoinCallRequest$Prefer;Ljava/util/List;ILkotlin/jvm/internal/DefaultConstructorMarker;)V + public fun (Ljava/lang/String;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Integer;Ljava/lang/String;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/util/List;Lio/getstream/android/video/generated/models/CallRequest;Lio/getstream/android/video/generated/models/JoinCallRequest$Prefer;Ljava/util/List;Ljava/lang/String;)V + public synthetic fun (Ljava/lang/String;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Integer;Ljava/lang/String;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/util/List;Lio/getstream/android/video/generated/models/CallRequest;Lio/getstream/android/video/generated/models/JoinCallRequest$Prefer;Ljava/util/List;Ljava/lang/String;ILkotlin/jvm/internal/DefaultConstructorMarker;)V public final fun component1 ()Ljava/lang/String; public final fun component10 ()Ljava/util/List; public final fun component11 ()Lio/getstream/android/video/generated/models/CallRequest; public final fun component12 ()Lio/getstream/android/video/generated/models/JoinCallRequest$Prefer; public final fun component13 ()Ljava/util/List; + public final fun component14 ()Ljava/lang/String; public final fun component2 ()Ljava/lang/Boolean; public final fun component3 ()Ljava/lang/Boolean; public final fun component4 ()Ljava/lang/Boolean; @@ -5712,8 +5778,8 @@ public final class io/getstream/android/video/generated/models/JoinCallRequest { public final fun component7 ()Ljava/lang/Boolean; public final fun component8 ()Ljava/lang/Boolean; public final fun component9 ()Ljava/lang/Boolean; - public final fun copy (Ljava/lang/String;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Integer;Ljava/lang/String;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/util/List;Lio/getstream/android/video/generated/models/CallRequest;Lio/getstream/android/video/generated/models/JoinCallRequest$Prefer;Ljava/util/List;)Lio/getstream/android/video/generated/models/JoinCallRequest; - public static synthetic fun copy$default (Lio/getstream/android/video/generated/models/JoinCallRequest;Ljava/lang/String;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Integer;Ljava/lang/String;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/util/List;Lio/getstream/android/video/generated/models/CallRequest;Lio/getstream/android/video/generated/models/JoinCallRequest$Prefer;Ljava/util/List;ILjava/lang/Object;)Lio/getstream/android/video/generated/models/JoinCallRequest; + public final fun copy (Ljava/lang/String;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Integer;Ljava/lang/String;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/util/List;Lio/getstream/android/video/generated/models/CallRequest;Lio/getstream/android/video/generated/models/JoinCallRequest$Prefer;Ljava/util/List;Ljava/lang/String;)Lio/getstream/android/video/generated/models/JoinCallRequest; + public static synthetic fun copy$default (Lio/getstream/android/video/generated/models/JoinCallRequest;Ljava/lang/String;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Integer;Ljava/lang/String;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/lang/Boolean;Ljava/util/List;Lio/getstream/android/video/generated/models/CallRequest;Lio/getstream/android/video/generated/models/JoinCallRequest$Prefer;Ljava/util/List;Ljava/lang/String;ILjava/lang/Object;)Lio/getstream/android/video/generated/models/JoinCallRequest; public fun equals (Ljava/lang/Object;)Z public final fun getCreate ()Ljava/lang/Boolean; public final fun getData ()Lio/getstream/android/video/generated/models/CallRequest; @@ -5727,6 +5793,7 @@ public final class io/getstream/android/video/generated/models/JoinCallRequest { public final fun getPlaybackCapabilities ()Ljava/util/List; public final fun getPrefer ()Lio/getstream/android/video/generated/models/JoinCallRequest$Prefer; public final fun getRing ()Ljava/lang/Boolean; + public final fun getUnifiedSessionId ()Ljava/lang/String; public final fun getVideo ()Ljava/lang/Boolean; public fun hashCode ()I public fun toString ()Ljava/lang/String; @@ -7058,15 +7125,18 @@ public final class io/getstream/android/video/generated/models/PinResponseJsonAd } public final class io/getstream/android/video/generated/models/PlaybackResponse { - public fun (Ljava/lang/String;Lio/getstream/android/video/generated/models/PlaybackResponse$Reason;Lio/getstream/android/video/generated/models/PlaybackResponse$Type;)V + public fun (Ljava/lang/String;Lio/getstream/android/video/generated/models/PlaybackResponse$Reason;Lio/getstream/android/video/generated/models/PlaybackResponse$Type;Ljava/lang/String;)V + public synthetic fun (Ljava/lang/String;Lio/getstream/android/video/generated/models/PlaybackResponse$Reason;Lio/getstream/android/video/generated/models/PlaybackResponse$Type;Ljava/lang/String;ILkotlin/jvm/internal/DefaultConstructorMarker;)V public final fun component1 ()Ljava/lang/String; public final fun component2 ()Lio/getstream/android/video/generated/models/PlaybackResponse$Reason; public final fun component3 ()Lio/getstream/android/video/generated/models/PlaybackResponse$Type; - public final fun copy (Ljava/lang/String;Lio/getstream/android/video/generated/models/PlaybackResponse$Reason;Lio/getstream/android/video/generated/models/PlaybackResponse$Type;)Lio/getstream/android/video/generated/models/PlaybackResponse; - public static synthetic fun copy$default (Lio/getstream/android/video/generated/models/PlaybackResponse;Ljava/lang/String;Lio/getstream/android/video/generated/models/PlaybackResponse$Reason;Lio/getstream/android/video/generated/models/PlaybackResponse$Type;ILjava/lang/Object;)Lio/getstream/android/video/generated/models/PlaybackResponse; + public final fun component4 ()Ljava/lang/String; + public final fun copy (Ljava/lang/String;Lio/getstream/android/video/generated/models/PlaybackResponse$Reason;Lio/getstream/android/video/generated/models/PlaybackResponse$Type;Ljava/lang/String;)Lio/getstream/android/video/generated/models/PlaybackResponse; + public static synthetic fun copy$default (Lio/getstream/android/video/generated/models/PlaybackResponse;Ljava/lang/String;Lio/getstream/android/video/generated/models/PlaybackResponse$Reason;Lio/getstream/android/video/generated/models/PlaybackResponse$Type;Ljava/lang/String;ILjava/lang/Object;)Lio/getstream/android/video/generated/models/PlaybackResponse; public fun equals (Ljava/lang/Object;)Z public final fun getPlaylistUrl ()Ljava/lang/String; public final fun getReason ()Lio/getstream/android/video/generated/models/PlaybackResponse$Reason; + public final fun getStatsToken ()Ljava/lang/String; public final fun getType ()Lio/getstream/android/video/generated/models/PlaybackResponse$Type; public fun hashCode ()I public fun toString ()Ljava/lang/String; @@ -8511,6 +8581,73 @@ public final class io/getstream/android/video/generated/models/ReportClientEvent public fun toString ()Ljava/lang/String; } +public final class io/getstream/android/video/generated/models/ReportHLSStatsRequest { + public fun (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;JLjava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Lio/getstream/android/video/generated/models/HLSPlaybackStats;Ljava/util/List;)V + public synthetic fun (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;JLjava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Lio/getstream/android/video/generated/models/HLSPlaybackStats;Ljava/util/List;ILkotlin/jvm/internal/DefaultConstructorMarker;)V + public final fun component1 ()Ljava/lang/String; + public final fun component10 ()Ljava/lang/String; + public final fun component11 ()Ljava/lang/String; + public final fun component12 ()Ljava/lang/String; + public final fun component13 ()Lio/getstream/android/video/generated/models/HLSPlaybackStats; + public final fun component14 ()Ljava/util/List; + public final fun component2 ()Ljava/lang/String; + public final fun component3 ()Ljava/lang/String; + public final fun component4 ()Ljava/lang/String; + public final fun component5 ()Ljava/lang/String; + public final fun component6 ()J + public final fun component7 ()Ljava/lang/String; + public final fun component8 ()Ljava/lang/String; + public final fun component9 ()Ljava/lang/String; + public final fun copy (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;JLjava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Lio/getstream/android/video/generated/models/HLSPlaybackStats;Ljava/util/List;)Lio/getstream/android/video/generated/models/ReportHLSStatsRequest; + public static synthetic fun copy$default (Lio/getstream/android/video/generated/models/ReportHLSStatsRequest;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;JLjava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Lio/getstream/android/video/generated/models/HLSPlaybackStats;Ljava/util/List;ILjava/lang/Object;)Lio/getstream/android/video/generated/models/ReportHLSStatsRequest; + public fun equals (Ljava/lang/Object;)Z + public final fun getCallSessionId ()Ljava/lang/String; + public final fun getEndReason ()Ljava/lang/String; + public final fun getErrorCode ()Ljava/lang/String; + public final fun getEvents ()Ljava/util/List; + public final fun getOs ()Ljava/lang/String; + public final fun getOsVersion ()Ljava/lang/String; + public final fun getSdk ()Ljava/lang/String; + public final fun getSdkVersion ()Ljava/lang/String; + public final fun getStats ()Lio/getstream/android/video/generated/models/HLSPlaybackStats; + public final fun getStatsToken ()Ljava/lang/String; + public final fun getTimestamp ()J + public final fun getType ()Ljava/lang/String; + public final fun getUnifiedSessionId ()Ljava/lang/String; + public final fun getUserSessionId ()Ljava/lang/String; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + +public final class io/getstream/android/video/generated/models/ReportHLSStatsRequestJsonAdapter : com/squareup/moshi/JsonAdapter { + public fun (Lcom/squareup/moshi/Moshi;)V + public fun fromJson (Lcom/squareup/moshi/JsonReader;)Lio/getstream/android/video/generated/models/ReportHLSStatsRequest; + public synthetic fun fromJson (Lcom/squareup/moshi/JsonReader;)Ljava/lang/Object; + public fun toJson (Lcom/squareup/moshi/JsonWriter;Lio/getstream/android/video/generated/models/ReportHLSStatsRequest;)V + public synthetic fun toJson (Lcom/squareup/moshi/JsonWriter;Ljava/lang/Object;)V + public fun toString ()Ljava/lang/String; +} + +public final class io/getstream/android/video/generated/models/ReportHLSStatsResponse { + public fun (Ljava/lang/String;)V + public final fun component1 ()Ljava/lang/String; + public final fun copy (Ljava/lang/String;)Lio/getstream/android/video/generated/models/ReportHLSStatsResponse; + public static synthetic fun copy$default (Lio/getstream/android/video/generated/models/ReportHLSStatsResponse;Ljava/lang/String;ILjava/lang/Object;)Lio/getstream/android/video/generated/models/ReportHLSStatsResponse; + public fun equals (Ljava/lang/Object;)Z + public final fun getDuration ()Ljava/lang/String; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + +public final class io/getstream/android/video/generated/models/ReportHLSStatsResponseJsonAdapter : com/squareup/moshi/JsonAdapter { + public fun (Lcom/squareup/moshi/Moshi;)V + public fun fromJson (Lcom/squareup/moshi/JsonReader;)Lio/getstream/android/video/generated/models/ReportHLSStatsResponse; + public synthetic fun fromJson (Lcom/squareup/moshi/JsonReader;)Ljava/lang/Object; + public fun toJson (Lcom/squareup/moshi/JsonWriter;Lio/getstream/android/video/generated/models/ReportHLSStatsResponse;)V + public synthetic fun toJson (Lcom/squareup/moshi/JsonWriter;Ljava/lang/Object;)V + public fun toString ()Ljava/lang/String; +} + public final class io/getstream/android/video/generated/models/ReportResponse { public fun (Lio/getstream/android/video/generated/models/CallReportResponse;Lio/getstream/android/video/generated/models/ParticipantReportResponse;Lio/getstream/android/video/generated/models/UserRatingReportResponse;)V public final fun component1 ()Lio/getstream/android/video/generated/models/CallReportResponse; @@ -10123,13 +10260,18 @@ public final class io/getstream/android/video/generated/models/StartTranscriptio } public final class io/getstream/android/video/generated/models/StatsOptions { - public fun (ZI)V + public fun (ZILjava/lang/Boolean;Ljava/lang/Integer;)V + public synthetic fun (ZILjava/lang/Boolean;Ljava/lang/Integer;ILkotlin/jvm/internal/DefaultConstructorMarker;)V public final fun component1 ()Z public final fun component2 ()I - public final fun copy (ZI)Lio/getstream/android/video/generated/models/StatsOptions; - public static synthetic fun copy$default (Lio/getstream/android/video/generated/models/StatsOptions;ZIILjava/lang/Object;)Lio/getstream/android/video/generated/models/StatsOptions; + public final fun component3 ()Ljava/lang/Boolean; + public final fun component4 ()Ljava/lang/Integer; + public final fun copy (ZILjava/lang/Boolean;Ljava/lang/Integer;)Lio/getstream/android/video/generated/models/StatsOptions; + public static synthetic fun copy$default (Lio/getstream/android/video/generated/models/StatsOptions;ZILjava/lang/Boolean;Ljava/lang/Integer;ILjava/lang/Object;)Lio/getstream/android/video/generated/models/StatsOptions; public fun equals (Ljava/lang/Object;)Z + public final fun getEnableHlsStats ()Ljava/lang/Boolean; public final fun getEnableRtcStats ()Z + public final fun getReportingHlsIntervalMs ()Ljava/lang/Integer; public final fun getReportingIntervalMs ()I public fun hashCode ()I public fun toString ()Ljava/lang/String; @@ -13462,13 +13604,44 @@ public final class io/getstream/video/android/core/call/connection/StreamPeerCon public final fun toggleAudioProcessing ()Z } +public abstract interface class io/getstream/video/android/core/call/hls/HlsPlaybackListener { + public abstract fun onPlaybackError (Ljava/lang/String;)V + public abstract fun onPlaybackStateChanged (Lio/getstream/video/android/core/call/hls/HlsPlaybackState;)V +} + +public final class io/getstream/video/android/core/call/hls/HlsPlaybackMetrics { + public fun ()V + public fun (IJJIII)V + public synthetic fun (IJJIIIILkotlin/jvm/internal/DefaultConstructorMarker;)V + public final fun getBitrateKbps ()I + public final fun getBufferLengthMs ()J + public final fun getDroppedFrames ()I + public final fun getHeight ()I + public final fun getLiveLatencyMs ()J + public final fun getWidth ()I +} + +public final class io/getstream/video/android/core/call/hls/HlsPlaybackState : java/lang/Enum { + public static final field Buffering Lio/getstream/video/android/core/call/hls/HlsPlaybackState; + public static final field Ended Lio/getstream/video/android/core/call/hls/HlsPlaybackState; + public static final field Loading Lio/getstream/video/android/core/call/hls/HlsPlaybackState; + public static final field Paused Lio/getstream/video/android/core/call/hls/HlsPlaybackState; + public static final field Playing Lio/getstream/video/android/core/call/hls/HlsPlaybackState; + public static final field Seeking Lio/getstream/video/android/core/call/hls/HlsPlaybackState; + public static fun getEntries ()Lkotlin/enums/EnumEntries; + public static fun valueOf (Ljava/lang/String;)Lio/getstream/video/android/core/call/hls/HlsPlaybackState; + public static fun values ()[Lio/getstream/video/android/core/call/hls/HlsPlaybackState; +} + public abstract interface class io/getstream/video/android/core/call/hls/HlsPlayer { public abstract fun attach (Landroid/view/SurfaceView;)V public abstract fun detach (Landroid/view/SurfaceView;)V public abstract fun getPlaylistUrl ()Ljava/lang/String; public abstract fun getVideoAspectRatio ()Lkotlinx/coroutines/flow/StateFlow; + public fun readPlaybackMetrics ()Lio/getstream/video/android/core/call/hls/HlsPlaybackMetrics; public abstract fun release ()V public abstract fun setAudioEnabled (Z)V + public fun setPlaybackListener (Lio/getstream/video/android/core/call/hls/HlsPlaybackListener;)V } public abstract interface class io/getstream/video/android/core/call/hls/HlsPlayerFactory { diff --git a/stream-video-android-core/src/main/kotlin/io/getstream/android/video/generated/apis/ProductvideoApi.kt b/stream-video-android-core/src/main/kotlin/io/getstream/android/video/generated/apis/ProductvideoApi.kt index e44dc15e09e..d8c3ee6d194 100644 --- a/stream-video-android-core/src/main/kotlin/io/getstream/android/video/generated/apis/ProductvideoApi.kt +++ b/stream-video-android-core/src/main/kotlin/io/getstream/android/video/generated/apis/ProductvideoApi.kt @@ -183,6 +183,17 @@ interface ProductvideoApi { @Path("id") id: kotlin.String ): io.getstream.android.video.generated.models.SendCallEventResponse + /** + * Report HLS playback stats + * Reports HLS player lifecycle and playback stats for a viewer that join call sent to HLS playback + */ + @POST("/video/call/{type}/{id}/hls_stats") + suspend fun reportHLSStats( + @Path("type") type: kotlin.String, + @Path("id") id: kotlin.String, + @Body reportHLSStatsRequest: io.getstream.android.video.generated.models.ReportHLSStatsRequest + ): io.getstream.android.video.generated.models.ReportHLSStatsResponse + /** * Collect user feedback * diff --git a/stream-video-android-core/src/main/kotlin/io/getstream/android/video/generated/models/HLSPlaybackStats.kt b/stream-video-android-core/src/main/kotlin/io/getstream/android/video/generated/models/HLSPlaybackStats.kt new file mode 100644 index 00000000000..363c010ffd9 --- /dev/null +++ b/stream-video-android-core/src/main/kotlin/io/getstream/android/video/generated/models/HLSPlaybackStats.kt @@ -0,0 +1,68 @@ +/* + * Copyright (c) 2014-2026 Stream.io Inc. All rights reserved. + * + * Licensed under the Stream License; + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://github.com/GetStream/stream-video-android/blob/main/LICENSE + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + +package io.getstream.android.video.generated.models + +import kotlin.collections.List +import kotlin.collections.Map +import kotlin.collections.* +import kotlin.io.* +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * A full snapshot of the HLS player's stats, so the latest report replaces earlier ones + */ + +@JsonClass(generateAdapter = true) +data class HLSPlaybackStats ( + @Json(name = "watch_duration_ms") + val watchDurationMs: kotlin.Long, + + @Json(name = "stall_count") + val stallCount: kotlin.Int, + + @Json(name = "stall_duration_ms") + val stallDurationMs: kotlin.Long, + + @Json(name = "max_stall_duration_ms") + val maxStallDurationMs: kotlin.Long, + + @Json(name = "dropped_frames") + val droppedFrames: kotlin.Int? = null, + + @Json(name = "bitrate_kbps") + val bitrateKbps: kotlin.Int? = null, + + @Json(name = "buffer_length_ms") + val bufferLengthMs: kotlin.Int? = null, + + @Json(name = "live_latency_ms") + val liveLatencyMs: kotlin.Int? = null, + + @Json(name = "width") + val width: kotlin.Int? = null, + + @Json(name = "height") + val height: kotlin.Int? = null +) diff --git a/stream-video-android-core/src/main/kotlin/io/getstream/android/video/generated/models/HLSPlayerEvent.kt b/stream-video-android-core/src/main/kotlin/io/getstream/android/video/generated/models/HLSPlayerEvent.kt new file mode 100644 index 00000000000..a27a418b4d1 --- /dev/null +++ b/stream-video-android-core/src/main/kotlin/io/getstream/android/video/generated/models/HLSPlayerEvent.kt @@ -0,0 +1,47 @@ +/* + * Copyright (c) 2014-2026 Stream.io Inc. All rights reserved. + * + * Licensed under the Stream License; + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://github.com/GetStream/stream-video-android/blob/main/LICENSE + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + +package io.getstream.android.video.generated.models + +import kotlin.collections.List +import kotlin.collections.Map +import kotlin.collections.* +import kotlin.io.* +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * A discrete HLS player event (stall, quality switch, error) + */ + +@JsonClass(generateAdapter = true) +data class HLSPlayerEvent ( + @Json(name = "type") + val type: kotlin.String, + + @Json(name = "timestamp") + val timestamp: kotlin.Long, + + @Json(name = "data") + val data: kotlin.collections.Map? = null +) diff --git a/stream-video-android-core/src/main/kotlin/io/getstream/android/video/generated/models/JoinCallRequest.kt b/stream-video-android-core/src/main/kotlin/io/getstream/android/video/generated/models/JoinCallRequest.kt index cd6c690fb91..ce6c781e037 100644 --- a/stream-video-android-core/src/main/kotlin/io/getstream/android/video/generated/models/JoinCallRequest.kt +++ b/stream-video-android-core/src/main/kotlin/io/getstream/android/video/generated/models/JoinCallRequest.kt @@ -78,7 +78,10 @@ data class JoinCallRequest ( val prefer: Prefer? = null, @Json(name = "playback_capabilities") - val playbackCapabilities: kotlin.collections.List? = emptyList() + val playbackCapabilities: kotlin.collections.List? = emptyList(), + + @Json(name = "unified_session_id") + val unifiedSessionId: kotlin.String? = null ) { diff --git a/stream-video-android-core/src/main/kotlin/io/getstream/android/video/generated/models/PlaybackResponse.kt b/stream-video-android-core/src/main/kotlin/io/getstream/android/video/generated/models/PlaybackResponse.kt index 53d66ae0f4b..19155c82691 100644 --- a/stream-video-android-core/src/main/kotlin/io/getstream/android/video/generated/models/PlaybackResponse.kt +++ b/stream-video-android-core/src/main/kotlin/io/getstream/android/video/generated/models/PlaybackResponse.kt @@ -48,7 +48,10 @@ data class PlaybackResponse ( val reason: Reason, @Json(name = "type") - val type: Type + val type: Type, + + @Json(name = "stats_token") + val statsToken: kotlin.String? = null ) { diff --git a/stream-video-android-core/src/main/kotlin/io/getstream/android/video/generated/models/ReportHLSStatsRequest.kt b/stream-video-android-core/src/main/kotlin/io/getstream/android/video/generated/models/ReportHLSStatsRequest.kt new file mode 100644 index 00000000000..9a69a60e378 --- /dev/null +++ b/stream-video-android-core/src/main/kotlin/io/getstream/android/video/generated/models/ReportHLSStatsRequest.kt @@ -0,0 +1,80 @@ +/* + * Copyright (c) 2014-2026 Stream.io Inc. All rights reserved. + * + * Licensed under the Stream License; + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://github.com/GetStream/stream-video-android/blob/main/LICENSE + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + +package io.getstream.android.video.generated.models + +import kotlin.collections.List +import kotlin.collections.Map +import kotlin.collections.* +import kotlin.io.* +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * A playback report from a viewer that join call sent to HLS playback + */ + +@JsonClass(generateAdapter = true) +data class ReportHLSStatsRequest ( + @Json(name = "stats_token") + val statsToken: kotlin.String, + + @Json(name = "call_session_id") + val callSessionId: kotlin.String, + + @Json(name = "user_session_id") + val userSessionId: kotlin.String, + + @Json(name = "unified_session_id") + val unifiedSessionId: kotlin.String, + + @Json(name = "type") + val type: kotlin.String, + + @Json(name = "timestamp") + val timestamp: kotlin.Long, + + @Json(name = "sdk") + val sdk: kotlin.String? = null, + + @Json(name = "sdk_version") + val sdkVersion: kotlin.String? = null, + + @Json(name = "os") + val os: kotlin.String? = null, + + @Json(name = "os_version") + val osVersion: kotlin.String? = null, + + @Json(name = "end_reason") + val endReason: kotlin.String? = null, + + @Json(name = "error_code") + val errorCode: kotlin.String? = null, + + @Json(name = "stats") + val stats: io.getstream.android.video.generated.models.HLSPlaybackStats? = null, + + @Json(name = "events") + val events: kotlin.collections.List? = null +) diff --git a/stream-video-android-core/src/main/kotlin/io/getstream/android/video/generated/models/ReportHLSStatsResponse.kt b/stream-video-android-core/src/main/kotlin/io/getstream/android/video/generated/models/ReportHLSStatsResponse.kt new file mode 100644 index 00000000000..b5264376bd5 --- /dev/null +++ b/stream-video-android-core/src/main/kotlin/io/getstream/android/video/generated/models/ReportHLSStatsResponse.kt @@ -0,0 +1,41 @@ +/* + * Copyright (c) 2014-2026 Stream.io Inc. All rights reserved. + * + * Licensed under the Stream License; + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://github.com/GetStream/stream-video-android/blob/main/LICENSE + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +@file:Suppress( + "ArrayInDataClass", + "EnumEntryName", + "RemoveRedundantQualifierName", + "UnusedImport" +) + +package io.getstream.android.video.generated.models + +import kotlin.collections.List +import kotlin.collections.Map +import kotlin.collections.* +import kotlin.io.* +import com.squareup.moshi.Json +import com.squareup.moshi.JsonClass + +/** + * Basic response information + */ + +@JsonClass(generateAdapter = true) +data class ReportHLSStatsResponse ( + @Json(name = "duration") + val duration: kotlin.String +) diff --git a/stream-video-android-core/src/main/kotlin/io/getstream/android/video/generated/models/StatsOptions.kt b/stream-video-android-core/src/main/kotlin/io/getstream/android/video/generated/models/StatsOptions.kt index a7ed7e3bec2..c9c9f06b2d3 100644 --- a/stream-video-android-core/src/main/kotlin/io/getstream/android/video/generated/models/StatsOptions.kt +++ b/stream-video-android-core/src/main/kotlin/io/getstream/android/video/generated/models/StatsOptions.kt @@ -45,5 +45,11 @@ data class StatsOptions ( val enableRtcStats: kotlin.Boolean, @Json(name = "reporting_interval_ms") - val reportingIntervalMs: kotlin.Int + val reportingIntervalMs: kotlin.Int, + + @Json(name = "enable_hls_stats") + val enableHlsStats: kotlin.Boolean? = null, + + @Json(name = "reporting_hls_interval_ms") + val reportingHlsIntervalMs: kotlin.Int? = null ) diff --git a/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/Call.kt b/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/Call.kt index d556972b0fd..5550f3d6c28 100644 --- a/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/Call.kt +++ b/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/Call.kt @@ -74,7 +74,10 @@ import io.getstream.video.android.core.call.components.NoiseCancellationPolicy import io.getstream.video.android.core.call.components.RtcSessionFactory import io.getstream.video.android.core.call.components.SessionMonitor import io.getstream.video.android.core.call.connection.StreamPeerConnectionFactory +import io.getstream.video.android.core.call.hls.CoordinatorHlsStatsDelivery import io.getstream.video.android.core.call.hls.HlsPlayer +import io.getstream.video.android.core.call.hls.HlsStatsConfig +import io.getstream.video.android.core.call.hls.HlsStatsReporter import io.getstream.video.android.core.call.scope.ScopeProvider import io.getstream.video.android.core.call.scope.ScopeProviderImpl import io.getstream.video.android.core.call.video.VideoFilter @@ -570,6 +573,17 @@ public class Call( } } }, + createHlsStatsReporter = { player, joinResponse -> + HlsStatsConfig.from(joinResponse, sessionManager.unifiedSessionId)?.let { config -> + HlsStatsReporter( + config = config, + player = player, + delivery = CoordinatorHlsStatsDelivery(clientImpl, type, id), + // The ended report outlives the call scope, which leave cancels. + scope = clientImpl.scope, + ) + } + }, ) internal var reconnectDeadlineMillis: Int diff --git a/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/StreamVideoClient.kt b/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/StreamVideoClient.kt index 714fde5f867..8a083743d6c 100644 --- a/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/StreamVideoClient.kt +++ b/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/StreamVideoClient.kt @@ -50,6 +50,8 @@ import io.getstream.android.video.generated.models.QueryCallMembersResponse import io.getstream.android.video.generated.models.QueryCallsRequest import io.getstream.android.video.generated.models.RejectCallRequest import io.getstream.android.video.generated.models.RejectCallResponse +import io.getstream.android.video.generated.models.ReportHLSStatsRequest +import io.getstream.android.video.generated.models.ReportHLSStatsResponse import io.getstream.android.video.generated.models.RequestPermissionRequest import io.getstream.android.video.generated.models.RingCallRequest import io.getstream.android.video.generated.models.RingCallResponse @@ -868,6 +870,7 @@ internal class StreamVideoClient internal constructor( hintHighScaleLivestreamPublisher: Boolean? = null, e2ee: Boolean? = null, playbackCapabilities: List? = null, + unifiedSessionId: String? = null, ): Result { val joinCallRequest = JoinCallRequest( create = create, @@ -886,6 +889,7 @@ internal class StreamVideoClient internal constructor( migratingFromList = migratingFromList, hintHighScaleLivestreamPublisher = hintHighScaleLivestreamPublisher, playbackCapabilities = playbackCapabilities, + unifiedSessionId = unifiedSessionId, ) val result = apiCall { @@ -899,6 +903,18 @@ internal class StreamVideoClient internal constructor( return result } + suspend fun reportHlsStats( + type: String, + id: String, + request: ReportHLSStatsRequest, + ): Result = apiCall { + coordinatorConnectionModule.api.reportHLSStats( + type = type, + id = id, + reportHLSStatsRequest = request, + ) + } + suspend fun updateMembers( type: String, id: String, diff --git a/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/call/components/CallApiClient.kt b/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/call/components/CallApiClient.kt index 64f70033acd..9872051c428 100644 --- a/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/call/components/CallApiClient.kt +++ b/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/call/components/CallApiClient.kt @@ -134,6 +134,7 @@ internal class CallApiClient( hintHighScaleLivestreamPublisher = hintHighScaleLivestreamPublisher, e2ee = requestE2ee, playbackCapabilities = playbackCapabilities, + unifiedSessionId = sessionManager.unifiedSessionId, ) result.onSuccess { callAnalytics.joinAnalytics.onJoinRequestSuccess( diff --git a/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/call/components/CallJoinCoordinator.kt b/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/call/components/CallJoinCoordinator.kt index 4a15b7c4347..af4299ef0db 100644 --- a/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/call/components/CallJoinCoordinator.kt +++ b/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/call/components/CallJoinCoordinator.kt @@ -40,6 +40,7 @@ import io.getstream.video.android.core.call.RtcSession import io.getstream.video.android.core.call.SfuConnectFailureCause import io.getstream.video.android.core.call.SfuConnectionResult import io.getstream.video.android.core.call.hls.HlsPlayer +import io.getstream.video.android.core.call.hls.HlsStatsReporter import io.getstream.video.android.core.model.PlaybackType import io.getstream.video.android.core.model.toIceServer import io.getstream.video.android.core.ringing.RingJoinSource @@ -80,6 +81,10 @@ internal class CallJoinCoordinator( // Returns the builder of the call's HLS player from a playlist URL, read at join time. Null // when the app registered no HlsPlayerFactory: the join then never asks for HLS. private val hlsPlayerFactory: () -> ((playlistUrl: String) -> HlsPlayer)? = { null }, + // Builds the reporter of the HLS player's stats, or null when the join response did not + // enable HLS stats. + private val createHlsStatsReporter: (HlsPlayer, JoinCallResponse) -> HlsStatsReporter? = + { _, _ -> null }, ) { private companion object { const val JOIN_FLIGHT_KEY = "join" @@ -454,7 +459,7 @@ internal class CallJoinCoordinator( return result as Failure } result.value.playback?.let { playback -> - return joinPlayback(playback) + return joinPlayback(playback, result.value) } val sfuToken = result.value.credentials.token val sfuUrl = result.value.credentials.server.url @@ -503,7 +508,10 @@ internal class CallJoinCoordinator( * The returned session is held as [CallSessionManager.playbackSession], never as the active * session, and the call's [HlsPlayer] as [CallSessionManager.hlsPlayer]. */ - private fun joinPlayback(playback: PlaybackResponse): Result { + private fun joinPlayback( + playback: PlaybackResponse, + joinResponse: JoinCallResponse, + ): Result { val playlistUrl = playback.playlistUrl val createPlayer = hlsPlayerFactory() if (playback.type != PlaybackResponse.Type.Hls || playlistUrl.isBlank() || createPlayer == null) { @@ -536,6 +544,7 @@ internal class CallJoinCoordinator( logger.i { "[joinInternal] Joined with HLS playback (reason=${playback.reason})" } sessionManager.playbackSession = session sessionManager.hlsPlayer.value = player + sessionManager.hlsStatsReporter = startHlsStatsReporter(player, joinResponse) state._playbackType.value = PlaybackType.Hls(playlistUrl) state._connection.value = RealtimeConnection.Joined(session) callRegistry.markActive() @@ -544,6 +553,17 @@ internal class CallJoinCoordinator( } } + /** Stats reporting is best effort: a reporter that fails to start leaves playback running. */ + private fun startHlsStatsReporter( + player: HlsPlayer, + joinResponse: JoinCallResponse, + ): HlsStatsReporter? = try { + createHlsStatsReporter(player, joinResponse)?.also { it.start() } + } catch (e: Exception) { + logger.e(e) { "[joinPlayback] Could not start HLS stats reporting" } + null + } + private suspend fun completeJoinAfterSessionInstall( localSession: RtcSession, joinResponse: JoinCallResponse, diff --git a/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/call/components/CallLifecycleManager.kt b/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/call/components/CallLifecycleManager.kt index 3e7f80c51a2..d17914c54e3 100644 --- a/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/call/components/CallLifecycleManager.kt +++ b/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/call/components/CallLifecycleManager.kt @@ -174,6 +174,8 @@ internal class CallLifecycleManager( } private fun clearPlayback() { + sessionManager.hlsStatsReporter?.stop() + sessionManager.hlsStatsReporter = null val player = sessionManager.hlsPlayer.value sessionManager.hlsPlayer.value = null state._playbackType.value = PlaybackType.WebRtc diff --git a/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/call/components/CallSessionManager.kt b/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/call/components/CallSessionManager.kt index 932f7dd3cdf..303fb0596fb 100644 --- a/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/call/components/CallSessionManager.kt +++ b/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/call/components/CallSessionManager.kt @@ -20,6 +20,7 @@ import io.getstream.log.taggedLogger import io.getstream.video.android.core.call.EmptyRtcSession import io.getstream.video.android.core.call.RtcSession import io.getstream.video.android.core.call.hls.HlsPlayer +import io.getstream.video.android.core.call.hls.HlsStatsReporter import kotlinx.coroutines.flow.MutableStateFlow import kotlinx.coroutines.flow.StateFlow import kotlinx.coroutines.flow.asStateFlow @@ -70,6 +71,10 @@ internal class CallSessionManager() { /** The call's HLS player. Set and cleared together with [playbackSession]. */ val hlsPlayer = MutableStateFlow(null) + /** Reports [hlsPlayer] playback to `hls_stats`, when the backend enabled HLS stats. */ + @Volatile + var hlsStatsReporter: HlsStatsReporter? = null + var sessionId = UUID.randomUUID().toString() val unifiedSessionId = UUID.randomUUID().toString() diff --git a/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/call/hls/HlsPlayer.kt b/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/call/hls/HlsPlayer.kt index 24d93ea5001..cd722f26d5f 100644 --- a/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/call/hls/HlsPlayer.kt +++ b/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/call/hls/HlsPlayer.kt @@ -59,8 +59,77 @@ public interface HlsPlayer { /** Stops playback for good. Called by the SDK when the call is left, from any thread. */ public fun release() + + /** + * Receives the player's state and errors for the call's HLS stats reports, or stops when + * [listener] is null. Called by the SDK from any thread; the listener is called on the main + * thread. A player that does not report keeps the default, and the call then sends no reports. + */ + public fun setPlaybackListener(listener: HlsPlaybackListener?) {} + + /** + * Current readings for an HLS stats report, or null before playback starts or after [release]. + * Main thread only. + */ + public fun readPlaybackMetrics(): HlsPlaybackMetrics? = null } +/** Player state and errors reported to the SDK. See [HlsPlayer.setPlaybackListener]. */ +public interface HlsPlaybackListener { + + /** The player moved to [state]. Repeating the current state is allowed and ignored. */ + public fun onPlaybackStateChanged(state: HlsPlaybackState) + + /** + * Playback failed. [code] names the error, for example `ERROR_CODE_BEHIND_LIVE_WINDOW`, and + * must not contain the playlist URL. + */ + public fun onPlaybackError(code: String) +} + +/** + * Player states the SDK derives stalls and watch time from. A stall is [Playing] followed by + * [Buffering]; the initial [Loading], a [Seeking] and a [Paused] are not stalls. + */ +public enum class HlsPlaybackState { + /** Loading before the first frame plays. */ + Loading, + + /** Playing media. */ + Playing, + + /** Waiting for data after playback had started. */ + Buffering, + + /** Loading after a seek. */ + Seeking, + + /** Not playing because playback is paused or suppressed. */ + Paused, + + /** The broadcast ended. */ + Ended, +} + +/** + * Current player readings for an HLS stats report. A value the player does not know yet is 0. + * + * @property bitrateKbps Bitrate of the rendition playing now. + * @property bufferLengthMs Media buffered ahead of the playhead. + * @property liveLatencyMs Distance behind the live edge. + * @property droppedFrames Video frames dropped by the decoder since playback started. + * @property width Width of the rendition playing now, in pixels. + * @property height Height of the rendition playing now, in pixels. + */ +public class HlsPlaybackMetrics( + public val bitrateKbps: Int = 0, + public val bufferLengthMs: Long = 0, + public val liveLatencyMs: Long = 0, + public val droppedFrames: Int = 0, + public val width: Int = 0, + public val height: Int = 0, +) + /** * Builds the [HlsPlayer] for a call the backend serves as HLS. Pass one to * [StreamVideoBuilder] to enable HLS playback: without it the SDK never asks the backend for HLS, diff --git a/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/call/hls/HlsStatsCollector.kt b/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/call/hls/HlsStatsCollector.kt new file mode 100644 index 00000000000..64e1c834a22 --- /dev/null +++ b/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/call/hls/HlsStatsCollector.kt @@ -0,0 +1,182 @@ +/* + * Copyright (c) 2014-2026 Stream.io Inc. All rights reserved. + * + * Licensed under the Stream License; + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://github.com/GetStream/stream-video-android/blob/main/LICENSE + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package io.getstream.video.android.core.call.hls + +import android.os.SystemClock +import io.getstream.android.video.generated.models.HLSPlaybackStats +import io.getstream.android.video.generated.models.HLSPlayerEvent +import io.getstream.log.taggedLogger +import java.util.Collections +import java.util.IdentityHashMap + +/** Clocks for HLS stats: [elapsedMs] measures durations, [wallMs] stamps reports and events. */ +internal interface HlsStatsClock { + fun elapsedMs(): Long + fun wallMs(): Long + + object System : HlsStatsClock { + override fun elapsedMs(): Long = SystemClock.elapsedRealtime() + override fun wallMs(): Long = java.lang.System.currentTimeMillis() + } +} + +/** + * Turns player states into the counters and events of the HLS stats reports, using the stall + * definition shared by every SDK: a stall starts when [HlsPlaybackState.Playing] moves to + * [HlsPlaybackState.Buffering] and ends when playback resumes. Loading before the first frame, + * seeking and pausing are not stalls. Watch time counts [HlsPlaybackState.Playing] only. + * + * Events stay buffered until a report carrying them is accepted, see [acknowledgeEvents]. + * Thread-safe: the player reports on the main thread while reports are built elsewhere. + */ +internal class HlsStatsCollector(private val clock: HlsStatsClock) { + + companion object { + const val EVENT_STALL_START = "stall_start" + const val EVENT_STALL_END = "stall_end" + const val EVENT_ERROR = "error" + + /** Oldest events are dropped beyond this, so a long outage cannot grow the buffer forever. */ + const val MAX_BUFFERED_EVENTS = 1_000 + } + + private val logger by taggedLogger("Video:HlsStatsCollector") + private val lock = Any() + + private var state: HlsPlaybackState? = null + private var hasPlayed = false + private var finished = false + private var playingSinceMs: Long? = null + private var watchMs = 0L + private var stallSinceMs: Long? = null + private var stallCount = 0 + private var stallMs = 0L + private var maxStallMs = 0L + private var lastErrorCode: String? = null + private var lastMetrics: HlsPlaybackMetrics? = null + private val events = ArrayDeque() + + /** The code of the last playback error, or null if playback never failed. */ + val errorCode: String? get() = synchronized(lock) { lastErrorCode } + + /** Applies a state change. Returns true when this is the first time playback plays. */ + fun onState(newState: HlsPlaybackState): Boolean = synchronized(lock) { + if (finished || newState == state) return false + val now = clock.elapsedMs() + playingSinceMs?.let { watchMs += now - it } + playingSinceMs = null + var firstPlay = false + when (newState) { + HlsPlaybackState.Playing -> { + endStall(now) + playingSinceMs = now + firstPlay = !hasPlayed + hasPlayed = true + } + HlsPlaybackState.Buffering -> if (state == HlsPlaybackState.Playing) startStall(now) + HlsPlaybackState.Loading, + HlsPlaybackState.Seeking, + HlsPlaybackState.Paused, + HlsPlaybackState.Ended, + -> endStall(now) + } + state = newState + firstPlay + } + + /** Records a playback error. The same code reported again in a row is recorded once. */ + fun onError(code: String) = synchronized(lock) { + if (finished || code == lastErrorCode) return + lastErrorCode = code + addEvent(EVENT_ERROR, mapOf("code" to code)) + } + + /** + * Cumulative stats since playback started, with [metrics] as the current readings. Null + * [metrics] reuses the last readings, for example once the player is released. + */ + fun stats(metrics: HlsPlaybackMetrics?): HLSPlaybackStats = synchronized(lock) { + if (metrics != null) lastMetrics = metrics + val now = clock.elapsedMs() + val openStallMs = stallSinceMs?.let { now - it } ?: 0L + val readings = lastMetrics + HLSPlaybackStats( + watchDurationMs = watchMs + (playingSinceMs?.let { now - it } ?: 0L), + stallCount = stallCount, + stallDurationMs = stallMs + openStallMs, + maxStallDurationMs = maxOf(maxStallMs, openStallMs), + droppedFrames = readings?.droppedFrames?.coerceAtLeast(0) ?: 0, + bitrateKbps = readings?.bitrateKbps?.coerceAtLeast(0) ?: 0, + bufferLengthMs = readings?.bufferLengthMs.toIntMs(), + liveLatencyMs = readings?.liveLatencyMs.toIntMs(), + width = readings?.width?.coerceAtLeast(0) ?: 0, + height = readings?.height?.coerceAtLeast(0) ?: 0, + ) + } + + /** The oldest buffered events, at most [max]. They stay buffered until acknowledged. */ + fun pendingEvents(max: Int): List = synchronized(lock) { events.take(max) } + + /** + * Drops [sent] after a report carrying them was handled. Events already dropped because the + * buffer was full are skipped. + */ + fun acknowledgeEvents(sent: List) = synchronized(lock) { + val handled = sent.toIdentitySet() + while (events.isNotEmpty() && events.first() in handled) events.removeFirst() + } + + private fun List.toIdentitySet(): Set = + Collections.newSetFromMap( + IdentityHashMap(), + ).also { it.addAll(this) } + + /** Stops counting: ends watch time and closes an open stall. Later states are ignored. */ + fun finish() = synchronized(lock) { + if (finished) return + val now = clock.elapsedMs() + playingSinceMs?.let { watchMs += now - it } + playingSinceMs = null + endStall(now) + finished = true + } + + private fun startStall(now: Long) { + stallSinceMs = now + stallCount++ + addEvent(EVENT_STALL_START) + } + + private fun endStall(now: Long) { + val since = stallSinceMs ?: return + val durationMs = (now - since).coerceAtLeast(0) + stallMs += durationMs + maxStallMs = maxOf(maxStallMs, durationMs) + stallSinceMs = null + addEvent(EVENT_STALL_END, mapOf("duration_ms" to durationMs)) + } + + private fun addEvent(type: String, data: Map? = null) { + if (events.size >= MAX_BUFFERED_EVENTS) { + events.removeFirst() + logger.w { "[addEvent] Event buffer full, dropped the oldest event" } + } + events.addLast(HLSPlayerEvent(type = type, timestamp = clock.wallMs(), data = data)) + } + + private fun Long?.toIntMs(): Int = (this ?: 0L).coerceIn(0L, Int.MAX_VALUE.toLong()).toInt() +} diff --git a/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/call/hls/HlsStatsDelivery.kt b/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/call/hls/HlsStatsDelivery.kt new file mode 100644 index 00000000000..337e30ca6bd --- /dev/null +++ b/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/call/hls/HlsStatsDelivery.kt @@ -0,0 +1,72 @@ +/* + * Copyright (c) 2014-2026 Stream.io Inc. All rights reserved. + * + * Licensed under the Stream License; + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://github.com/GetStream/stream-video-android/blob/main/LICENSE + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package io.getstream.video.android.core.call.hls + +import io.getstream.android.video.generated.models.ReportHLSStatsRequest +import io.getstream.result.Error +import io.getstream.result.Result +import io.getstream.video.android.core.StreamVideoClient +import retrofit2.HttpException + +/** How the backend answered an HLS stats report. */ +internal enum class HlsStatsDeliveryResult { + /** Accepted (2xx). */ + Delivered, + + /** Invalid report (4xx other than 403 and 429). Sending it again cannot succeed. */ + Rejected, + + /** The stats token is invalid, expired, or for another session or user (403). */ + Forbidden, + + /** Rate limited, a server error, or no response. Worth retrying. */ + Failed, +} + +/** Posts one HLS stats report. */ +internal fun interface HlsStatsDelivery { + suspend fun deliver(request: ReportHLSStatsRequest): HlsStatsDeliveryResult +} + +/** Posts reports for the call [type]:[id] to `POST /video/call/{type}/{id}/hls_stats`. */ +internal class CoordinatorHlsStatsDelivery( + private val client: StreamVideoClient, + private val type: String, + private val id: String, +) : HlsStatsDelivery { + + override suspend fun deliver(request: ReportHLSStatsRequest): HlsStatsDeliveryResult = + when (val result = client.reportHlsStats(type, id, request)) { + is Result.Success -> HlsStatsDeliveryResult.Delivered + is Result.Failure -> hlsStatsDeliveryResultOf(result.value) + } +} + +internal fun hlsStatsDeliveryResultOf(error: Error): HlsStatsDeliveryResult { + val statusCode = when (error) { + is Error.NetworkError -> error.statusCode + is Error.ThrowableError -> (error.cause as? HttpException)?.code() + else -> null + } + return when { + statusCode == null -> HlsStatsDeliveryResult.Failed + statusCode == 403 -> HlsStatsDeliveryResult.Forbidden + statusCode == 429 || statusCode >= 500 -> HlsStatsDeliveryResult.Failed + statusCode in 400..499 -> HlsStatsDeliveryResult.Rejected + else -> HlsStatsDeliveryResult.Failed + } +} diff --git a/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/call/hls/HlsStatsReporter.kt b/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/call/hls/HlsStatsReporter.kt new file mode 100644 index 00000000000..db1d54355aa --- /dev/null +++ b/stream-video-android-core/src/main/kotlin/io/getstream/video/android/core/call/hls/HlsStatsReporter.kt @@ -0,0 +1,261 @@ +/* + * Copyright (c) 2014-2026 Stream.io Inc. All rights reserved. + * + * Licensed under the Stream License; + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://github.com/GetStream/stream-video-android/blob/main/LICENSE + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package io.getstream.video.android.core.call.hls + +import android.os.Build +import io.getstream.android.video.generated.models.HLSPlaybackStats +import io.getstream.android.video.generated.models.HLSPlayerEvent +import io.getstream.android.video.generated.models.JoinCallResponse +import io.getstream.android.video.generated.models.ReportHLSStatsRequest +import io.getstream.log.taggedLogger +import io.getstream.video.android.core.BuildConfig +import kotlinx.coroutines.CoroutineDispatcher +import kotlinx.coroutines.CoroutineScope +import kotlinx.coroutines.Dispatchers +import kotlinx.coroutines.Job +import kotlinx.coroutines.currentCoroutineContext +import kotlinx.coroutines.delay +import kotlinx.coroutines.ensureActive +import kotlinx.coroutines.isActive +import kotlinx.coroutines.launch +import kotlinx.coroutines.sync.Mutex +import kotlinx.coroutines.sync.withLock +import kotlinx.coroutines.withContext +import java.util.UUID + +/** What the reporter needs from the `join_call` response that sent the viewer to HLS. */ +internal class HlsStatsConfig( + val callSessionId: String, + val statsToken: String, + val unifiedSessionId: String, + val intervalMs: Long, +) { + companion object { + const val DEFAULT_INTERVAL_MS = 10_000L + + /** + * Returns null, so no reports are sent, unless the backend enabled HLS stats and signed a + * stats token for this call session. + */ + fun from(response: JoinCallResponse, unifiedSessionId: String): HlsStatsConfig? { + val options = response.statsOptions + if (options.enableHlsStats != true) return null + val statsToken = response.playback?.statsToken?.takeIf { it.isNotBlank() } ?: return null + val callSessionId = response.call.currentSessionId.takeIf { it.isNotBlank() } ?: return null + val intervalMs = options.reportingHlsIntervalMs?.takeIf { it > 0 } + ?: options.reportingIntervalMs.takeIf { it > 0 } + return HlsStatsConfig( + callSessionId = callSessionId, + statsToken = statsToken, + unifiedSessionId = unifiedSessionId, + intervalMs = intervalMs?.toLong() ?: DEFAULT_INTERVAL_MS, + ) + } + } +} + +/** SDK and OS sent on every report. */ +internal class HlsStatsClientInfo( + val sdk: String, + val sdkVersion: String, + val os: String, + val osVersion: String, +) { + companion object { + fun current(): HlsStatsClientInfo = HlsStatsClientInfo( + sdk = "stream-android", + sdkVersion = BuildConfig.STREAM_VIDEO_VERSION, + os = "Android", + osVersion = Build.VERSION.RELEASE.orEmpty(), + ) + } +} + +/** + * Reports one HLS playback session of a call to `hls_stats`: `started` when the player first + * plays, `stats` every [HlsStatsConfig.intervalMs], and `ended` from [stop]. Every report carries + * the same `user_session_id`. + * + * Reports are sent one at a time. Player events ride on the next report and are dropped only + * once it is handled: a failed `stats` report keeps them for the next interval, and `started` and + * `ended` are retried with backoff. A 403 means the stats token is no longer valid, so the + * session stops reporting. + */ +internal class HlsStatsReporter( + private val config: HlsStatsConfig, + private val player: HlsPlayer, + private val delivery: HlsStatsDelivery, + private val scope: CoroutineScope, + private val mainDispatcher: CoroutineDispatcher = Dispatchers.Main, + private val clock: HlsStatsClock = HlsStatsClock.System, + private val clientInfo: HlsStatsClientInfo = HlsStatsClientInfo.current(), + private val retryDelaysMs: List = DEFAULT_RETRY_DELAYS_MS, +) { + companion object { + const val TYPE_STARTED = "started" + const val TYPE_STATS = "stats" + const val TYPE_ENDED = "ended" + const val END_REASON_LEFT = "left" + const val END_REASON_ERROR = "error" + const val MAX_EVENTS_PER_REPORT = 100 + val DEFAULT_RETRY_DELAYS_MS = listOf(1_000L, 2_000L, 4_000L) + + private const val MAX_SDK_LENGTH = 50 + private const val MAX_CLIENT_FIELD_LENGTH = 64 + private const val MAX_ERROR_CODE_LENGTH = 128 + } + + private val logger by taggedLogger("Video:HlsStatsReporter") + private val userSessionId = UUID.randomUUID().toString() + private val collector = HlsStatsCollector(clock) + private val sendMutex = Mutex() + private val lock = Any() + + // Guarded by [lock]. + private var started = false + private var stopped = false + private var reportingJob: Job? = null + + @Volatile + private var tokenRejected = false + + private val listener = object : HlsPlaybackListener { + override fun onPlaybackStateChanged(state: HlsPlaybackState) { + if (collector.onState(state)) onFirstPlay() + } + + override fun onPlaybackError(code: String) { + collector.onError(code.take(MAX_ERROR_CODE_LENGTH)) + } + } + + /** Starts listening to the player. Reporting begins when playback first plays. */ + fun start() { + player.setPlaybackListener(listener) + } + + /** + * Ends the session: stops listening and periodic reports, then sends `ended` if `started` + * was sent. Safe to call more than once, from any thread. + */ + fun stop() { + val job: Job? + val sendEnded: Boolean + synchronized(lock) { + if (stopped) return + stopped = true + job = reportingJob + sendEnded = started + } + player.setPlaybackListener(null) + collector.finish() + job?.cancel() + if (!sendEnded) return + scope.launch { + job?.join() + send(TYPE_ENDED, withStats = true, retry = true) + } + } + + private fun onFirstPlay() { + synchronized(lock) { + if (stopped || started) return + started = true + reportingJob = scope.launch { + send(TYPE_STARTED, withStats = false, retry = true) + while (isActive && !tokenRejected) { + delay(config.intervalMs) + send(TYPE_STATS, withStats = true, retry = false) + } + } + } + } + + private suspend fun send(type: String, withStats: Boolean, retry: Boolean) = sendMutex.withLock { + var attempt = 0 + while (!tokenRejected) { + val metrics = if (withStats) readMetrics() else null + val events = collector.pendingEvents(MAX_EVENTS_PER_REPORT) + val result = delivery.deliver( + buildReport( + type = type, + stats = if (withStats) collector.stats(metrics) else null, + events = events, + ), + ) + when (result) { + HlsStatsDeliveryResult.Delivered -> { + collector.acknowledgeEvents(events) + return@withLock + } + HlsStatsDeliveryResult.Rejected -> { + logger.e { "[send] The backend rejected the $type report as invalid" } + collector.acknowledgeEvents(events) + return@withLock + } + HlsStatsDeliveryResult.Forbidden -> { + logger.w { "[send] Stats token rejected, HLS stats reporting stopped" } + tokenRejected = true + return@withLock + } + HlsStatsDeliveryResult.Failed -> { + if (!retry || attempt >= retryDelaysMs.size) { + logger.w { "[send] Could not send the $type report" } + return@withLock + } + delay(retryDelaysMs[attempt++]) + } + } + } + } + + private suspend fun readMetrics(): HlsPlaybackMetrics? = try { + withContext(mainDispatcher) { player.readPlaybackMetrics() } + } catch (e: Exception) { + currentCoroutineContext().ensureActive() + logger.w { "[readMetrics] Could not read player metrics: ${e.message}" } + null + } + + private fun buildReport( + type: String, + stats: HLSPlaybackStats?, + events: List, + ): ReportHLSStatsRequest { + val errorCode = if (type == TYPE_ENDED) collector.errorCode else null + return ReportHLSStatsRequest( + statsToken = config.statsToken, + callSessionId = config.callSessionId, + userSessionId = userSessionId, + unifiedSessionId = config.unifiedSessionId, + type = type, + timestamp = clock.wallMs(), + sdk = clientInfo.sdk.take(MAX_SDK_LENGTH), + sdkVersion = clientInfo.sdkVersion.take(MAX_SDK_LENGTH), + os = clientInfo.os.take(MAX_CLIENT_FIELD_LENGTH), + osVersion = clientInfo.osVersion.take(MAX_CLIENT_FIELD_LENGTH), + endReason = when { + type != TYPE_ENDED -> null + errorCode != null -> END_REASON_ERROR + else -> END_REASON_LEFT + }, + errorCode = errorCode, + stats = stats, + events = events.takeIf { it.isNotEmpty() }, + ) + } +} diff --git a/stream-video-android-core/src/test/kotlin/io/getstream/video/android/core/call/components/CallApiClientTest.kt b/stream-video-android-core/src/test/kotlin/io/getstream/video/android/core/call/components/CallApiClientTest.kt index 6b673084250..b5f44b40e87 100644 --- a/stream-video-android-core/src/test/kotlin/io/getstream/video/android/core/call/components/CallApiClientTest.kt +++ b/stream-video-android-core/src/test/kotlin/io/getstream/video/android/core/call/components/CallApiClientTest.kt @@ -337,6 +337,7 @@ class CallApiClientTest { clientImpl.joinCall( any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), + any(), ) } returns Result.Failure(io.getstream.result.Error.GenericError("boom")) @@ -350,6 +351,7 @@ class CallApiClientTest { clientImpl.joinCall( any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), + any(), ) } } @@ -376,6 +378,7 @@ class CallApiClientTest { clientImpl.joinCall( any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), + any(), ) } returns Result.Failure(io.getstream.result.Error.GenericError("boom")) @@ -402,6 +405,7 @@ class CallApiClientTest { hintHighScaleLivestreamPublisher = any(), e2ee = true, playbackCapabilities = any(), + unifiedSessionId = any(), ) } } @@ -414,6 +418,7 @@ class CallApiClientTest { clientImpl.joinCall( any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), + any(), ) } returns Result.Failure(io.getstream.result.Error.GenericError("boom")) @@ -450,5 +455,44 @@ class CallApiClientTest { hintHighScaleLivestreamPublisher = any(), e2ee = any(), playbackCapabilities = capabilities, + unifiedSessionId = any(), + ) + + @Test + fun `joinRequest sends the call's unified session id`() = runTest(testDispatcher) { + coEvery { + clientImpl.joinCall( + any(), any(), any(), any(), any(), any(), any(), any(), + any(), any(), any(), any(), any(), any(), any(), any(), + any(), + ) + } returns Result.Failure(io.getstream.result.Error.GenericError("boom")) + + apiClient.joinRequest( + location = "test-location", + joinAnalyticsModel = JoinAnalyticsModel(0, JoinReason.FirstAttempt), ) + + coVerify { + clientImpl.joinCall( + type = any(), + id = any(), + create = any(), + members = any(), + custom = any(), + settingsOverride = any(), + startsAt = any(), + team = any(), + ring = any(), + notify = any(), + location = any(), + migratingFrom = any(), + migratingFromList = any(), + hintHighScaleLivestreamPublisher = any(), + e2ee = any(), + playbackCapabilities = any(), + unifiedSessionId = sessionManager.unifiedSessionId, + ) + } + } } diff --git a/stream-video-android-core/src/test/kotlin/io/getstream/video/android/core/call/components/CallJoinCoordinatorTest.kt b/stream-video-android-core/src/test/kotlin/io/getstream/video/android/core/call/components/CallJoinCoordinatorTest.kt index 31ae437ac76..88a6016f906 100644 --- a/stream-video-android-core/src/test/kotlin/io/getstream/video/android/core/call/components/CallJoinCoordinatorTest.kt +++ b/stream-video-android-core/src/test/kotlin/io/getstream/video/android/core/call/components/CallJoinCoordinatorTest.kt @@ -38,6 +38,7 @@ import io.getstream.video.android.core.call.RtcSession import io.getstream.video.android.core.call.SfuConnectFailureCause import io.getstream.video.android.core.call.SfuConnectionResult import io.getstream.video.android.core.call.hls.HlsPlayer +import io.getstream.video.android.core.call.hls.HlsStatsReporter import io.getstream.video.android.core.call.scope.ScopeProvider import io.getstream.video.android.core.model.PlaybackType import io.mockk.coEvery @@ -153,6 +154,10 @@ class CallJoinCoordinatorTest { private fun coordinator( createHlsPlayer: ((String) -> HlsPlayer)? = { hlsPlayer }, + createHlsStatsReporter: ( + HlsPlayer, + JoinCallResponse, + ) -> HlsStatsReporter? = { _, _ -> null }, ) = CallJoinCoordinator( clientImpl = clientImpl, state = state, @@ -171,6 +176,7 @@ class CallJoinCoordinatorTest { hasRequiredPermissions = { true }, createPlaybackSession = { playbackSession }, hlsPlayerFactory = { createHlsPlayer }, + createHlsStatsReporter = createHlsStatsReporter, ) private fun stubJoinCall(result: io.getstream.result.Result) { @@ -843,6 +849,58 @@ class CallJoinCoordinatorTest { verify(exactly = 0) { media.updateMediaManagerFromSettings(any()) } } + @Test + fun `HLS playback starts stats reporting for the installed player`() = runTest(testDispatcher) { + stubHlsPlayback() + val reporter = mockk(relaxed = true) + var reportedPlayer: HlsPlayer? = null + var reportedResponse: JoinCallResponse? = null + + coordinator( + createHlsStatsReporter = { player, response -> + reportedPlayer = player + reportedResponse = response + reporter + }, + ).join() + advanceUntilIdle() + + assertThat(reportedPlayer).isSameInstanceAs(hlsPlayer) + assertThat(reportedResponse).isSameInstanceAs(mockJoinResponse) + verify { reporter.start() } + verify { sessionManager.hlsStatsReporter = reporter } + } + + @Test + fun `stats reporting that fails to start does not fail the HLS join`() = runTest( + testDispatcher, + ) { + stubHlsPlayback() + val reporter = mockk { + every { start() } throws IllegalStateException("no listener") + } + + val result = coordinator(createHlsStatsReporter = { _, _ -> reporter }).join() + advanceUntilIdle() + + assertThat((result as Success).value).isSameInstanceAs(playbackSession) + assertThat(playbackTypeFlow.value).isEqualTo(PlaybackType.Hls(HLS_URL)) + verify { sessionManager.hlsStatsReporter = null } + verify { callRegistry.markActive() } + } + + @Test + fun `a WebRTC join does not start HLS stats reporting`() = runTest(testDispatcher) { + stubJoinCall(Success(mockJoinResponse)) + coEvery { mockSession.connectInternal() } returns SfuConnectionResult.Success + var created = false + + coordinator(createHlsStatsReporter = { _, _ -> null.also { created = true } }).join() + advanceUntilIdle() + + assertThat(created).isFalse() + } + @Test fun `join after HLS playback returns the playback session`() = runTest(testDispatcher) { stubHlsPlayback() diff --git a/stream-video-android-core/src/test/kotlin/io/getstream/video/android/core/call/components/CallLifecycleManagerTest.kt b/stream-video-android-core/src/test/kotlin/io/getstream/video/android/core/call/components/CallLifecycleManagerTest.kt index 1241d8b7a73..f10792c9870 100644 --- a/stream-video-android-core/src/test/kotlin/io/getstream/video/android/core/call/components/CallLifecycleManagerTest.kt +++ b/stream-video-android-core/src/test/kotlin/io/getstream/video/android/core/call/components/CallLifecycleManagerTest.kt @@ -22,11 +22,13 @@ import io.getstream.video.android.core.RealtimeConnection import io.getstream.video.android.core.StreamVideoClient import io.getstream.video.android.core.call.RtcSession import io.getstream.video.android.core.call.hls.HlsPlayer +import io.getstream.video.android.core.call.hls.HlsStatsReporter import io.getstream.video.android.core.model.PlaybackType import io.mockk.coVerify import io.mockk.every import io.mockk.mockk import io.mockk.verify +import io.mockk.verifyOrder import kotlinx.coroutines.flow.MutableStateFlow import kotlinx.coroutines.test.StandardTestDispatcher import kotlinx.coroutines.test.TestScope @@ -93,6 +95,24 @@ class CallLifecycleManagerTest { coVerify(exactly = 0) { playbackSession.sendLeaveEvent(any()) } } + @Test + fun `leave stops HLS stats reporting before releasing the player`() = runTest(testDispatcher) { + val player = mockk(relaxed = true) + val reporter = mockk(relaxed = true) + sessionManager.playbackSession = mockk(relaxed = true) + sessionManager.hlsPlayer.value = player + sessionManager.hlsStatsReporter = reporter + + manager().leave("user") + advanceUntilIdle() + + assertThat(sessionManager.hlsStatsReporter).isNull() + verifyOrder { + reporter.stop() + player.release() + } + } + @Test fun `leave marks the call left until the next join resets the guard`() = runTest( testDispatcher, diff --git a/stream-video-android-core/src/test/kotlin/io/getstream/video/android/core/call/hls/HlsStatsCollectorTest.kt b/stream-video-android-core/src/test/kotlin/io/getstream/video/android/core/call/hls/HlsStatsCollectorTest.kt new file mode 100644 index 00000000000..69667106437 --- /dev/null +++ b/stream-video-android-core/src/test/kotlin/io/getstream/video/android/core/call/hls/HlsStatsCollectorTest.kt @@ -0,0 +1,192 @@ +/* + * Copyright (c) 2014-2026 Stream.io Inc. All rights reserved. + * + * Licensed under the Stream License; + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://github.com/GetStream/stream-video-android/blob/main/LICENSE + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package io.getstream.video.android.core.call.hls + +import com.google.common.truth.Truth.assertThat +import io.getstream.video.android.core.call.hls.HlsPlaybackState.Buffering +import io.getstream.video.android.core.call.hls.HlsPlaybackState.Loading +import io.getstream.video.android.core.call.hls.HlsPlaybackState.Paused +import io.getstream.video.android.core.call.hls.HlsPlaybackState.Playing +import io.getstream.video.android.core.call.hls.HlsPlaybackState.Seeking +import org.junit.Test + +class HlsStatsCollectorTest { + + private val clock = FakeHlsStatsClock() + private val collector = HlsStatsCollector(clock) + + @Test + fun `only the first play is reported as first`() { + assertThat(collector.onState(Loading)).isFalse() + assertThat(collector.onState(Playing)).isTrue() + collector.onState(Paused) + + assertThat(collector.onState(Playing)).isFalse() + } + + @Test + fun `watch time counts playing only`() { + collector.onState(Loading) + clock.advance(500) + collector.onState(Playing) + clock.advance(3_000) + collector.onState(Paused) + clock.advance(10_000) + collector.onState(Playing) + clock.advance(1_000) + + assertThat(collector.stats(null).watchDurationMs).isEqualTo(4_000) + } + + @Test + fun `buffering after playing is a stall that ends when playback resumes`() { + collector.onState(Playing) + clock.advance(1_000) + collector.onState(Buffering) + clock.advance(700) + collector.onState(Playing) + + val stats = collector.stats(null) + assertThat(stats.stallCount).isEqualTo(1) + assertThat(stats.stallDurationMs).isEqualTo(700) + assertThat(stats.maxStallDurationMs).isEqualTo(700) + assertThat(stats.watchDurationMs).isEqualTo(1_000) + val events = collector.pendingEvents(10) + assertThat(events.map { it.type }) + .containsExactly(HlsStatsCollector.EVENT_STALL_START, HlsStatsCollector.EVENT_STALL_END) + .inOrder() + assertThat(events[1].data).containsExactly("duration_ms", 700L) + } + + @Test + fun `initial loading and seeking are not stalls`() { + collector.onState(Loading) + clock.advance(2_000) + collector.onState(Playing) + collector.onState(Seeking) + clock.advance(2_000) + collector.onState(Playing) + + assertThat(collector.stats(null).stallCount).isEqualTo(0) + assertThat(collector.pendingEvents(10)).isEmpty() + } + + @Test + fun `buffering after a pause is not a stall`() { + collector.onState(Playing) + collector.onState(Paused) + collector.onState(Buffering) + + assertThat(collector.stats(null).stallCount).isEqualTo(0) + } + + @Test + fun `pausing during a stall ends it`() { + collector.onState(Playing) + collector.onState(Buffering) + clock.advance(300) + collector.onState(Paused) + clock.advance(5_000) + + assertThat(collector.stats(null).stallDurationMs).isEqualTo(300) + } + + @Test + fun `an open stall is included in stats`() { + collector.onState(Playing) + collector.onState(Buffering) + clock.advance(400) + + val stats = collector.stats(null) + assertThat(stats.stallCount).isEqualTo(1) + assertThat(stats.stallDurationMs).isEqualTo(400) + assertThat(stats.maxStallDurationMs).isEqualTo(400) + } + + @Test + fun `finish closes the open stall and ignores later states`() { + collector.onState(Playing) + clock.advance(1_000) + collector.onState(Buffering) + clock.advance(200) + collector.finish() + clock.advance(5_000) + collector.onState(Playing) + clock.advance(5_000) + + val stats = collector.stats(null) + assertThat(stats.watchDurationMs).isEqualTo(1_000) + assertThat(stats.stallDurationMs).isEqualTo(200) + } + + @Test + fun `stats reuse the last metrics when none are given`() { + collector.stats(HlsPlaybackMetrics(bitrateKbps = 2_500, width = 1280, height = 720)) + + val stats = collector.stats(null) + assertThat(stats.bitrateKbps).isEqualTo(2_500) + assertThat(stats.width).isEqualTo(1280) + assertThat(stats.height).isEqualTo(720) + } + + @Test + fun `the same error code in a row is recorded once`() { + collector.onError("ERROR_CODE_IO_NETWORK_CONNECTION_FAILED") + collector.onError("ERROR_CODE_IO_NETWORK_CONNECTION_FAILED") + collector.onError("ERROR_CODE_BEHIND_LIVE_WINDOW") + + assertThat(collector.pendingEvents(10).map { it.data?.get("code") }) + .containsExactly( + "ERROR_CODE_IO_NETWORK_CONNECTION_FAILED", + "ERROR_CODE_BEHIND_LIVE_WINDOW", + ) + .inOrder() + assertThat(collector.errorCode).isEqualTo("ERROR_CODE_BEHIND_LIVE_WINDOW") + } + + @Test + fun `acknowledged events are dropped and newer events stay`() { + collector.onError("a") + val sent = collector.pendingEvents(10) + collector.onError("b") + + collector.acknowledgeEvents(sent) + + assertThat(collector.pendingEvents(10).map { it.data?.get("code") }).containsExactly("b") + } + + @Test + fun `the oldest events are dropped once the buffer is full`() { + repeat(HlsStatsCollector.MAX_BUFFERED_EVENTS + 1) { collector.onError("code-$it") } + + val events = collector.pendingEvents(Int.MAX_VALUE) + assertThat(events).hasSize(HlsStatsCollector.MAX_BUFFERED_EVENTS) + assertThat(events.first().data?.get("code")).isEqualTo("code-1") + } +} + +internal class FakeHlsStatsClock( + private var elapsed: Long = 0L, + private val wallOffset: Long = 1_700_000_000_000L, +) : HlsStatsClock { + fun advance(ms: Long) { + elapsed += ms + } + + override fun elapsedMs(): Long = elapsed + override fun wallMs(): Long = wallOffset + elapsed +} diff --git a/stream-video-android-core/src/test/kotlin/io/getstream/video/android/core/call/hls/HlsStatsConfigTest.kt b/stream-video-android-core/src/test/kotlin/io/getstream/video/android/core/call/hls/HlsStatsConfigTest.kt new file mode 100644 index 00000000000..c7e4f7050d5 --- /dev/null +++ b/stream-video-android-core/src/test/kotlin/io/getstream/video/android/core/call/hls/HlsStatsConfigTest.kt @@ -0,0 +1,113 @@ +/* + * Copyright (c) 2014-2026 Stream.io Inc. All rights reserved. + * + * Licensed under the Stream License; + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://github.com/GetStream/stream-video-android/blob/main/LICENSE + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package io.getstream.video.android.core.call.hls + +import com.google.common.truth.Truth.assertThat +import io.getstream.android.video.generated.models.JoinCallResponse +import io.getstream.android.video.generated.models.PlaybackResponse +import io.getstream.android.video.generated.models.StatsOptions +import io.getstream.result.Error +import io.mockk.every +import io.mockk.mockk +import okhttp3.ResponseBody.Companion.toResponseBody +import org.junit.Test +import retrofit2.HttpException +import retrofit2.Response + +class HlsStatsConfigTest { + + @Test + fun `reads the session, token and HLS interval`() { + val config = HlsStatsConfig.from(response(), "unified")!! + + assertThat(config.callSessionId).isEqualTo("call-session") + assertThat(config.statsToken).isEqualTo("token") + assertThat(config.unifiedSessionId).isEqualTo("unified") + assertThat(config.intervalMs).isEqualTo(5_000) + } + + @Test + fun `is null unless HLS stats are enabled`() { + assertThat(HlsStatsConfig.from(response(enabled = null), "unified")).isNull() + assertThat(HlsStatsConfig.from(response(enabled = false), "unified")).isNull() + } + + @Test + fun `is null without a stats token or call session`() { + assertThat(HlsStatsConfig.from(response(statsToken = null), "unified")).isNull() + assertThat(HlsStatsConfig.from(response(statsToken = " "), "unified")).isNull() + assertThat(HlsStatsConfig.from(response(callSessionId = ""), "unified")).isNull() + } + + @Test + fun `falls back to the RTC interval, then the default`() { + assertThat(HlsStatsConfig.from(response(hlsIntervalMs = null), "u")!!.intervalMs) + .isEqualTo(8_000) + assertThat( + HlsStatsConfig.from(response(hlsIntervalMs = 0, rtcIntervalMs = 0), "u")!!.intervalMs, + ).isEqualTo(HlsStatsConfig.DEFAULT_INTERVAL_MS) + } + + @Test + fun `maps response codes to delivery results`() { + assertThat( + hlsStatsDeliveryResultOf(httpError(400)), + ).isEqualTo(HlsStatsDeliveryResult.Rejected) + assertThat( + hlsStatsDeliveryResultOf(httpError(403)), + ).isEqualTo(HlsStatsDeliveryResult.Forbidden) + assertThat( + hlsStatsDeliveryResultOf(httpError(429)), + ).isEqualTo(HlsStatsDeliveryResult.Failed) + assertThat( + hlsStatsDeliveryResultOf(httpError(503)), + ).isEqualTo(HlsStatsDeliveryResult.Failed) + assertThat( + hlsStatsDeliveryResultOf( + Error.NetworkError("bad", serverErrorCode = 4, statusCode = 422), + ), + ).isEqualTo(HlsStatsDeliveryResult.Rejected) + assertThat(hlsStatsDeliveryResultOf(Error.ThrowableError("offline", java.io.IOException()))) + .isEqualTo(HlsStatsDeliveryResult.Failed) + } + + private fun httpError(code: Int): Error = Error.ThrowableError( + "HTTP $code", + HttpException(Response.error(code, "{}".toResponseBody())), + ) + + private fun response( + enabled: Boolean? = true, + statsToken: String? = "token", + callSessionId: String = "call-session", + hlsIntervalMs: Int? = 5_000, + rtcIntervalMs: Int = 8_000, + ): JoinCallResponse { + val playback = + mockk { every { this@mockk.statsToken } returns statsToken } + return mockk { + every { statsOptions } returns StatsOptions( + enableRtcStats = true, + reportingIntervalMs = rtcIntervalMs, + enableHlsStats = enabled, + reportingHlsIntervalMs = hlsIntervalMs, + ) + every { this@mockk.playback } returns playback + every { call.currentSessionId } returns callSessionId + } + } +} diff --git a/stream-video-android-core/src/test/kotlin/io/getstream/video/android/core/call/hls/HlsStatsReporterTest.kt b/stream-video-android-core/src/test/kotlin/io/getstream/video/android/core/call/hls/HlsStatsReporterTest.kt new file mode 100644 index 00000000000..ea9ea152a80 --- /dev/null +++ b/stream-video-android-core/src/test/kotlin/io/getstream/video/android/core/call/hls/HlsStatsReporterTest.kt @@ -0,0 +1,315 @@ +/* + * Copyright (c) 2014-2026 Stream.io Inc. All rights reserved. + * + * Licensed under the Stream License; + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://github.com/GetStream/stream-video-android/blob/main/LICENSE + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package io.getstream.video.android.core.call.hls + +import android.view.SurfaceView +import com.google.common.truth.Truth.assertThat +import io.getstream.android.video.generated.models.ReportHLSStatsRequest +import io.getstream.video.android.core.call.hls.HlsPlaybackState.Buffering +import io.getstream.video.android.core.call.hls.HlsPlaybackState.Loading +import io.getstream.video.android.core.call.hls.HlsPlaybackState.Playing +import io.getstream.video.android.core.call.hls.HlsStatsDeliveryResult.Delivered +import io.getstream.video.android.core.call.hls.HlsStatsDeliveryResult.Failed +import io.getstream.video.android.core.call.hls.HlsStatsDeliveryResult.Forbidden +import io.getstream.video.android.core.call.hls.HlsStatsDeliveryResult.Rejected +import kotlinx.coroutines.CoroutineScope +import kotlinx.coroutines.ExperimentalCoroutinesApi +import kotlinx.coroutines.Job +import kotlinx.coroutines.flow.MutableStateFlow +import kotlinx.coroutines.flow.StateFlow +import kotlinx.coroutines.test.StandardTestDispatcher +import kotlinx.coroutines.test.TestScope +import kotlinx.coroutines.test.advanceTimeBy +import kotlinx.coroutines.test.advanceUntilIdle +import kotlinx.coroutines.test.runCurrent +import org.junit.Test + +@OptIn(ExperimentalCoroutinesApi::class) +class HlsStatsReporterTest { + + companion object { + private const val INTERVAL_MS = 10_000L + } + + private val player = FakeReportingPlayer() + private val delivery = FakeDelivery() + + private val TestScope.reporter: HlsStatsReporter + get() = reporterOrNull ?: HlsStatsReporter( + config = HlsStatsConfig( + callSessionId = "call-session", + statsToken = "token", + unifiedSessionId = "unified-session", + intervalMs = INTERVAL_MS, + ), + player = player, + delivery = delivery, + // Not backgroundScope: advanceUntilIdle skips its work, such as the ended report. + scope = CoroutineScope(StandardTestDispatcher(testScheduler) + reporterJob), + mainDispatcher = StandardTestDispatcher(testScheduler), + clock = object : HlsStatsClock { + override fun elapsedMs(): Long = testScheduler.currentTime + override fun wallMs(): Long = 1_700_000_000_000L + testScheduler.currentTime + }, + clientInfo = HlsStatsClientInfo("stream-android", "1.0.0", "Android", "15"), + retryDelaysMs = listOf(1_000L, 2_000L), + ).also { + reporterOrNull = it + it.start() + } + + private var reporterOrNull: HlsStatsReporter? = null + private val reporterJob = Job() + + /** Ends the periodic reports, which runTest would otherwise run forever once the body ends. */ + private fun runTest(body: suspend TestScope.() -> Unit) = kotlinx.coroutines.test.runTest { + try { + body() + } finally { + reporterJob.cancel() + } + } + + @Test + fun `sends nothing until playback first plays`() = runTest { + reporter + player.emit(Loading) + advanceTimeBy(INTERVAL_MS * 3) + + assertThat(delivery.requests).isEmpty() + } + + @Test + fun `sends started without stats on first play`() = runTest { + reporter + player.emit(Playing) + runCurrent() + + val started = delivery.requests.single() + assertThat(started.type).isEqualTo(HlsStatsReporter.TYPE_STARTED) + assertThat(started.stats).isNull() + assertThat(started.statsToken).isEqualTo("token") + assertThat(started.callSessionId).isEqualTo("call-session") + assertThat(started.unifiedSessionId).isEqualTo("unified-session") + assertThat(started.userSessionId).isNotEmpty() + assertThat(started.sdk).isEqualTo("stream-android") + assertThat(started.os).isEqualTo("Android") + } + + @Test + fun `sends stats every interval with the same user session id`() = runTest { + reporter + player.emit(Playing) + advanceTimeBy(INTERVAL_MS * 2 + 1) + + assertThat(delivery.requests.map { it.type }).containsExactly( + HlsStatsReporter.TYPE_STARTED, + HlsStatsReporter.TYPE_STATS, + HlsStatsReporter.TYPE_STATS, + ).inOrder() + assertThat(delivery.requests.map { it.userSessionId }.toSet()).hasSize(1) + assertThat(delivery.requests.last().stats?.watchDurationMs).isEqualTo(INTERVAL_MS * 2) + } + + @Test + fun `stats carry the player readings`() = runTest { + player.metrics = HlsPlaybackMetrics(bitrateKbps = 3_000, width = 1920, height = 1080) + reporter + player.emit(Playing) + advanceTimeBy(INTERVAL_MS + 1) + + val stats = delivery.requests.last().stats!! + assertThat(stats.bitrateKbps).isEqualTo(3_000) + assertThat(stats.width).isEqualTo(1920) + } + + @Test + fun `delivered events are not sent again`() = runTest { + reporter + player.emit(Playing) + runCurrent() + stall() + advanceTimeBy(INTERVAL_MS * 2) + + val stats = delivery.requests.filter { it.type == HlsStatsReporter.TYPE_STATS } + assertThat(stats[0].events?.map { it.type }).containsExactly( + HlsStatsCollector.EVENT_STALL_START, + HlsStatsCollector.EVENT_STALL_END, + ) + assertThat(stats[1].events).isNull() + } + + @Test + fun `a failed stats report keeps its events for the next one`() = runTest { + reporter + player.emit(Playing) + runCurrent() + stall() + delivery.results.add(Failed) + advanceTimeBy(INTERVAL_MS * 2) + + val stats = delivery.requests.filter { it.type == HlsStatsReporter.TYPE_STATS } + assertThat(stats).hasSize(2) + assertThat(stats[1].events?.map { it.type }).containsExactly( + HlsStatsCollector.EVENT_STALL_START, + HlsStatsCollector.EVENT_STALL_END, + ) + } + + @Test + fun `a rejected report drops its events`() = runTest { + reporter + player.emit(Playing) + runCurrent() + stall() + delivery.results.add(Rejected) + advanceTimeBy(INTERVAL_MS * 2) + + val stats = delivery.requests.filter { it.type == HlsStatsReporter.TYPE_STATS } + assertThat(stats).hasSize(2) + assertThat(stats[1].events).isNull() + } + + @Test + fun `a rejected stats token stops reporting, including ended`() = runTest { + reporter + delivery.results.add(Forbidden) + player.emit(Playing) + advanceTimeBy(INTERVAL_MS * 3) + reporter.stop() + advanceUntilIdle() + + assertThat(delivery.requests.map { it.type }).containsExactly(HlsStatsReporter.TYPE_STARTED) + } + + @Test + fun `started is retried until delivered`() = runTest { + reporter + delivery.results.addAll(listOf(Failed, Failed)) + player.emit(Playing) + advanceTimeBy(3_001) + + assertThat(delivery.requests.map { it.type }).containsExactly( + HlsStatsReporter.TYPE_STARTED, + HlsStatsReporter.TYPE_STARTED, + HlsStatsReporter.TYPE_STARTED, + ) + } + + @Test + fun `stop sends ended with reason left`() = runTest { + reporter + player.emit(Playing) + advanceTimeBy(1_000) + reporter.stop() + advanceUntilIdle() + + val ended = delivery.requests.last() + assertThat(ended.type).isEqualTo(HlsStatsReporter.TYPE_ENDED) + assertThat(ended.endReason).isEqualTo(HlsStatsReporter.END_REASON_LEFT) + assertThat(ended.errorCode).isNull() + assertThat(ended.stats?.watchDurationMs).isEqualTo(1_000) + assertThat(delivery.requests.count { it.type == HlsStatsReporter.TYPE_STATS }).isEqualTo(0) + } + + @Test + fun `ended after a playback error carries the error code`() = runTest { + reporter + player.emit(Playing) + runCurrent() + player.listener?.onPlaybackError("ERROR_CODE_BEHIND_LIVE_WINDOW") + reporter.stop() + advanceUntilIdle() + + val ended = delivery.requests.last() + assertThat(ended.endReason).isEqualTo(HlsStatsReporter.END_REASON_ERROR) + assertThat(ended.errorCode).isEqualTo("ERROR_CODE_BEHIND_LIVE_WINDOW") + assertThat(ended.events?.map { it.type }).containsExactly(HlsStatsCollector.EVENT_ERROR) + } + + @Test + fun `ended is retried until delivered`() = runTest { + reporter + player.emit(Playing) + runCurrent() + delivery.results.addAll(listOf(Failed, Failed)) + reporter.stop() + advanceUntilIdle() + + assertThat(delivery.requests.count { it.type == HlsStatsReporter.TYPE_ENDED }).isEqualTo(3) + } + + @Test + fun `stop before playback plays sends nothing`() = runTest { + reporter + player.emit(Loading) + reporter.stop() + player.emit(Playing) + advanceUntilIdle() + + assertThat(delivery.requests).isEmpty() + } + + @Test + fun `stop clears the player listener and a second stop sends nothing more`() = runTest { + reporter + player.emit(Playing) + runCurrent() + reporter.stop() + reporter.stop() + advanceUntilIdle() + + assertThat(player.listener).isNull() + assertThat(delivery.requests.count { it.type == HlsStatsReporter.TYPE_ENDED }).isEqualTo(1) + } + + private fun TestScope.stall() { + player.emit(Buffering) + advanceTimeBy(500) + player.emit(Playing) + } + + private class FakeDelivery : HlsStatsDelivery { + val requests = mutableListOf() + val results = ArrayDeque() + + override suspend fun deliver(request: ReportHLSStatsRequest): HlsStatsDeliveryResult { + requests += request + return results.removeFirstOrNull() ?: Delivered + } + } + + private class FakeReportingPlayer : HlsPlayer { + var listener: HlsPlaybackListener? = null + var metrics: HlsPlaybackMetrics? = HlsPlaybackMetrics() + + override val playlistUrl: String = "https://example.com/playlist.m3u8" + override val videoAspectRatio: StateFlow = MutableStateFlow(null) + override fun attach(surfaceView: SurfaceView) = Unit + override fun detach(surfaceView: SurfaceView) = Unit + override fun setAudioEnabled(enabled: Boolean) = Unit + override fun release() = Unit + override fun setPlaybackListener(listener: HlsPlaybackListener?) { + this.listener = listener + } + override fun readPlaybackMetrics(): HlsPlaybackMetrics? = metrics + + fun emit(state: HlsPlaybackState) { + listener?.onPlaybackStateChanged(state) + } + } +} diff --git a/stream-video-android-core/src/test/kotlin/io/getstream/video/android/core/e2ee/CallE2EETest.kt b/stream-video-android-core/src/test/kotlin/io/getstream/video/android/core/e2ee/CallE2EETest.kt index 05f9c74650e..e99a8bb326a 100644 --- a/stream-video-android-core/src/test/kotlin/io/getstream/video/android/core/e2ee/CallE2EETest.kt +++ b/stream-video-android-core/src/test/kotlin/io/getstream/video/android/core/e2ee/CallE2EETest.kt @@ -98,6 +98,7 @@ class CallE2EETest { mockClientImpl.joinCall( any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), any(), + any(), ) } returns Result.Failure(Error.GenericError("not under test")) @@ -197,6 +198,7 @@ class CallE2EETest { hintHighScaleLivestreamPublisher = any(), e2ee = true, playbackCapabilities = any(), + unifiedSessionId = any(), ) } } @@ -226,6 +228,7 @@ class CallE2EETest { hintHighScaleLivestreamPublisher = any(), e2ee = false, playbackCapabilities = any(), + unifiedSessionId = any(), ) } } diff --git a/stream-video-android-core/src/test/kotlin/io/getstream/video/android/core/model/PlaybackSerializationTest.kt b/stream-video-android-core/src/test/kotlin/io/getstream/video/android/core/model/PlaybackSerializationTest.kt index c3fea617b97..84972e4d76a 100644 --- a/stream-video-android-core/src/test/kotlin/io/getstream/video/android/core/model/PlaybackSerializationTest.kt +++ b/stream-video-android-core/src/test/kotlin/io/getstream/video/android/core/model/PlaybackSerializationTest.kt @@ -18,8 +18,12 @@ package io.getstream.video.android.core.model import com.google.common.truth.Truth.assertThat import io.getstream.android.video.generated.infrastructure.Serializer +import io.getstream.android.video.generated.models.HLSPlaybackStats +import io.getstream.android.video.generated.models.HLSPlayerEvent import io.getstream.android.video.generated.models.JoinCallRequest import io.getstream.android.video.generated.models.PlaybackResponse +import io.getstream.android.video.generated.models.ReportHLSStatsRequest +import io.getstream.android.video.generated.models.StatsOptions import org.junit.Test class PlaybackSerializationTest { @@ -53,6 +57,57 @@ class PlaybackSerializationTest { ) } + @Test + fun `playback response parses the stats token`() { + val playback = Serializer.moshi.adapter(PlaybackResponse::class.java).fromJson( + """{"type":"hls","playlist_url":"u","reason":"percentage","stats_token":"t"}""", + ) + + assertThat(playback?.statsToken).isEqualTo("t") + } + + @Test + fun `stats options parse the HLS stats settings`() { + val options = Serializer.moshi.adapter(StatsOptions::class.java).fromJson( + """{"enable_rtc_stats":true,"reporting_interval_ms":8000,"enable_hls_stats":true,"reporting_hls_interval_ms":5000}""", + ) + + assertThat(options?.enableHlsStats).isTrue() + assertThat(options?.reportingHlsIntervalMs).isEqualTo(5000) + } + + @Test + fun `HLS stats report uses the backend field names`() { + val json = Serializer.moshi.adapter(ReportHLSStatsRequest::class.java).toJson( + ReportHLSStatsRequest( + statsToken = "t", + callSessionId = "c", + userSessionId = "u", + unifiedSessionId = "s", + type = "ended", + timestamp = 1L, + endReason = "left", + stats = HLSPlaybackStats( + watchDurationMs = 2L, + stallCount = 1, + stallDurationMs = 3L, + maxStallDurationMs = 3L, + ), + events = listOf(HLSPlayerEvent("stall_end", 4L, mapOf("duration_ms" to 3L))), + ), + ) + + assertThat(json).contains("\"stats_token\":\"t\"") + assertThat(json).contains("\"call_session_id\":\"c\"") + assertThat(json).contains("\"user_session_id\":\"u\"") + assertThat(json).contains("\"unified_session_id\":\"s\"") + assertThat(json).contains("\"end_reason\":\"left\"") + assertThat(json).contains("\"watch_duration_ms\":2") + assertThat(json).contains("\"max_stall_duration_ms\":3") + assertThat(json).contains("\"data\":{\"duration_ms\":3}") + assertThat(json).doesNotContain("user_id") + } + @Test fun `playback response keeps unknown types and reasons`() { val playback = Serializer.moshi.adapter(PlaybackResponse::class.java).fromJson( diff --git a/stream-video-android-hls/src/main/kotlin/io/getstream/video/android/hls/ExoHlsPlayer.kt b/stream-video-android-hls/src/main/kotlin/io/getstream/video/android/hls/ExoHlsPlayer.kt index fa2a06291d3..31d8f0b189b 100644 --- a/stream-video-android-hls/src/main/kotlin/io/getstream/video/android/hls/ExoHlsPlayer.kt +++ b/stream-video-android-hls/src/main/kotlin/io/getstream/video/android/hls/ExoHlsPlayer.kt @@ -20,11 +20,20 @@ import android.content.Context import android.os.Handler import android.os.Looper import android.view.SurfaceView +import androidx.annotation.OptIn +import androidx.media3.common.C +import androidx.media3.common.Format import androidx.media3.common.MediaItem +import androidx.media3.common.PlaybackException import androidx.media3.common.Player import androidx.media3.common.VideoSize +import androidx.media3.common.util.UnstableApi import androidx.media3.exoplayer.ExoPlayer +import androidx.media3.exoplayer.analytics.AnalyticsListener import io.getstream.video.android.core.StreamVideoBuilder +import io.getstream.video.android.core.call.hls.HlsPlaybackListener +import io.getstream.video.android.core.call.hls.HlsPlaybackMetrics +import io.getstream.video.android.core.call.hls.HlsPlaybackState import io.getstream.video.android.core.call.hls.HlsPlayer import io.getstream.video.android.core.call.hls.HlsPlayerFactory import kotlinx.coroutines.flow.MutableStateFlow @@ -70,6 +79,11 @@ internal class ExoHlsPlayer( private var surface: SurfaceView? = null private var audioEnabled = true private var released = false + private var playbackListener: HlsPlaybackListener? = null + private var reportedState: HlsPlaybackState? = null + private var hasPlayed = false + private var seeking = false + private var droppedFrames = 0 internal val exoPlayer: ExoPlayer? get() = player internal val attachedSurface: SurfaceView? get() = surface @@ -96,22 +110,60 @@ internal class ExoHlsPlayer( player?.volume = volumeFor(enabled) } - override fun release() { - if (Looper.myLooper() == Looper.getMainLooper()) { - releaseOnMain() - } else { - mainHandler.post(::releaseOnMain) - } + override fun release() = onMain(::releaseOnMain) + + override fun setPlaybackListener(listener: HlsPlaybackListener?) = onMain { + if (released) return@onMain + playbackListener = listener + reportedState = null + player?.let(::reportState) + } + + @OptIn(UnstableApi::class) + override fun readPlaybackMetrics(): HlsPlaybackMetrics? { + val player = player ?: return null + val format = player.videoFormat + val liveOffsetMs = player.currentLiveOffset + return HlsPlaybackMetrics( + bitrateKbps = format?.bitrate?.takeIf { it != Format.NO_VALUE }?.div(1000) ?: 0, + bufferLengthMs = player.totalBufferedDuration, + liveLatencyMs = if (liveOffsetMs == C.TIME_UNSET) 0 else liveOffsetMs, + droppedFrames = droppedFrames, + width = format?.width?.takeIf { it != Format.NO_VALUE } ?: player.videoSize.width, + height = format?.height?.takeIf { it != Format.NO_VALUE } ?: player.videoSize.height, + ) + } + + private fun onMain(block: () -> Unit) { + if (Looper.myLooper() == Looper.getMainLooper()) block() else mainHandler.post(block) } private fun releaseOnMain() { if (released) return released = true surface = null + playbackListener = null player?.release() player = null } + private fun reportState(player: Player) { + val state = hlsPlaybackStateOf( + playbackState = player.playbackState, + playWhenReady = player.playWhenReady, + isPlaying = player.isPlaying, + hasPlayed = hasPlayed, + seeking = seeking, + ) ?: return + if (state == HlsPlaybackState.Playing) { + hasPlayed = true + seeking = false + } + if (state == reportedState) return + reportedState = state + playbackListener?.onPlaybackStateChanged(state) + } + private fun buildPlayer(): ExoPlayer { val player = ExoPlayer.Builder(context).build() try { @@ -120,6 +172,40 @@ internal class ExoHlsPlayer( override fun onVideoSizeChanged(videoSize: VideoSize) { videoAspectRatioOf(videoSize)?.let { _videoAspectRatio.value = it } } + + override fun onPositionDiscontinuity( + oldPosition: Player.PositionInfo, + newPosition: Player.PositionInfo, + reason: Int, + ) { + if (reason == Player.DISCONTINUITY_REASON_SEEK) seeking = true + } + + override fun onPlayerError(error: PlaybackException) { + playbackListener?.onPlaybackError(error.errorCodeName) + } + + override fun onEvents(player: Player, events: Player.Events) { + if (events.containsAny( + Player.EVENT_PLAYBACK_STATE_CHANGED, + Player.EVENT_PLAY_WHEN_READY_CHANGED, + Player.EVENT_IS_PLAYING_CHANGED, + ) + ) { + reportState(player) + } + } + }, + ) + player.addAnalyticsListener( + object : AnalyticsListener { + override fun onDroppedVideoFrames( + eventTime: AnalyticsListener.EventTime, + droppedFrames: Int, + elapsedMs: Long, + ) { + this@ExoHlsPlayer.droppedFrames += droppedFrames + } }, ) player.volume = volumeFor(audioEnabled) @@ -135,6 +221,31 @@ internal class ExoHlsPlayer( private fun volumeFor(enabled: Boolean): Float = if (enabled) 1f else 0f } +/** + * Maps ExoPlayer's state to the state the SDK derives stalls from. Buffering before the first + * play is [HlsPlaybackState.Loading], and after a seek [HlsPlaybackState.Seeking], so neither + * counts as a stall. Null while idle. + */ +internal fun hlsPlaybackStateOf( + playbackState: @Player.State Int, + playWhenReady: Boolean, + isPlaying: Boolean, + hasPlayed: Boolean, + seeking: Boolean, +): HlsPlaybackState? = when { + playbackState == Player.STATE_IDLE -> null + playbackState == Player.STATE_ENDED -> HlsPlaybackState.Ended + isPlaying -> HlsPlaybackState.Playing + !playWhenReady -> HlsPlaybackState.Paused + playbackState == Player.STATE_BUFFERING -> when { + !hasPlayed -> HlsPlaybackState.Loading + seeking -> HlsPlaybackState.Seeking + else -> HlsPlaybackState.Buffering + } + // Ready with playWhenReady set but not playing: playback is suppressed, e.g. by audio focus. + else -> HlsPlaybackState.Paused +} + /** Display aspect ratio of [videoSize], accounting for non-square pixels. Null while unknown. */ internal fun videoAspectRatioOf(videoSize: VideoSize): Float? { if (videoSize.width <= 0 || videoSize.height <= 0) return null diff --git a/stream-video-android-hls/src/test/kotlin/io/getstream/video/android/hls/ExoHlsPlayerTest.kt b/stream-video-android-hls/src/test/kotlin/io/getstream/video/android/hls/ExoHlsPlayerTest.kt index 7acbf707609..9b5ef6b5f5f 100644 --- a/stream-video-android-hls/src/test/kotlin/io/getstream/video/android/hls/ExoHlsPlayerTest.kt +++ b/stream-video-android-hls/src/test/kotlin/io/getstream/video/android/hls/ExoHlsPlayerTest.kt @@ -18,8 +18,11 @@ package io.getstream.video.android.hls import android.os.Looper import android.view.SurfaceView +import androidx.media3.common.Player import androidx.media3.common.VideoSize import com.google.common.truth.Truth.assertThat +import io.getstream.video.android.core.call.hls.HlsPlaybackListener +import io.getstream.video.android.core.call.hls.HlsPlaybackState import org.junit.After import org.junit.Test import org.junit.runner.RunWith @@ -112,6 +115,76 @@ internal class ExoHlsPlayerTest { assertThat(player.exoPlayer).isNull() } + @Test + fun `metrics are read only while exoplayer exists`() { + assertThat(player.readPlaybackMetrics()).isNull() + + player.attach(SurfaceView(application)) + val metrics = player.readPlaybackMetrics()!! + assertThat(metrics.droppedFrames).isEqualTo(0) + assertThat(metrics.liveLatencyMs).isAtLeast(0) + + player.release() + assertThat(player.readPlaybackMetrics()).isNull() + } + + @Test + fun `a listener set after release is never called`() { + val states = mutableListOf() + player.attach(SurfaceView(application)) + player.release() + + player.setPlaybackListener( + object : HlsPlaybackListener { + override fun onPlaybackStateChanged(state: HlsPlaybackState) { + states += state + } + + override fun onPlaybackError(code: String) = Unit + }, + ) + shadowOf(Looper.getMainLooper()).idle() + + assertThat(states).isEmpty() + } + + @Test + fun `buffering is loading before the first play, seeking after a seek, else a stall`() { + fun state(hasPlayed: Boolean, seeking: Boolean) = hlsPlaybackStateOf( + playbackState = Player.STATE_BUFFERING, + playWhenReady = true, + isPlaying = false, + hasPlayed = hasPlayed, + seeking = seeking, + ) + + assertThat(state(hasPlayed = false, seeking = false)).isEqualTo(HlsPlaybackState.Loading) + assertThat(state(hasPlayed = true, seeking = true)).isEqualTo(HlsPlaybackState.Seeking) + assertThat(state(hasPlayed = true, seeking = false)).isEqualTo(HlsPlaybackState.Buffering) + } + + @Test + fun `playback state maps playing, paused, ended and idle`() { + fun state(playbackState: Int, playWhenReady: Boolean, isPlaying: Boolean) = + hlsPlaybackStateOf( + playbackState, + playWhenReady, + isPlaying, + hasPlayed = true, + seeking = false, + ) + + assertThat(state(Player.STATE_READY, playWhenReady = true, isPlaying = true)) + .isEqualTo(HlsPlaybackState.Playing) + assertThat(state(Player.STATE_BUFFERING, playWhenReady = false, isPlaying = false)) + .isEqualTo(HlsPlaybackState.Paused) + assertThat(state(Player.STATE_READY, playWhenReady = true, isPlaying = false)) + .isEqualTo(HlsPlaybackState.Paused) + assertThat(state(Player.STATE_ENDED, playWhenReady = true, isPlaying = false)) + .isEqualTo(HlsPlaybackState.Ended) + assertThat(state(Player.STATE_IDLE, playWhenReady = true, isPlaying = false)).isNull() + } + @Test fun `aspect ratio uses the display shape and stays unknown without a frame size`() { assertThat(videoAspectRatioOf(VideoSize(1920, 1080))).isWithin(0.001f).of(16f / 9f)