Skip to content
This repository has been archived by the owner on Jun 28, 2024. It is now read-only.

Fix api documentation #11

Closed
wants to merge 5 commits into from
Closed

Fix api documentation #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
529775f
init
skyman503 Aug 4, 2023
18ce08d
markdown
skyman503 Aug 4, 2023
72cf2cd
markdown working
skyman503 Aug 4, 2023
cd88789
xd
skyman503 Aug 4, 2023
c342ee1
lint
skyman503 Aug 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/publish_docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

name: Deploy Docs
on:
workflow_dispatch:
push:
tags:
- "*"
Expand All @@ -25,4 +25,4 @@ jobs:
REPO: self
BRANCH: gh-pages
FOLDER: JellyfishClient/build/dokka/html
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
4 changes: 3 additions & 1 deletion JellyfishClient/module.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Module JellyfishClient

## Overview
# Package com.jellyfishdev.jellyfishclient.webrtc

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm confused now, those are docs for webrtc, not jellyfish? Is it intentional?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, those docs are there to provide an quick and easy way for jellyfish client user to understand how the webrtc functions that we're exposing through type aliases work. There is no easy way of exporting docs for types I made aliases of, and copy pasting them seems like a huge mistake, so I figured that this is the best solution

See [membrane-webrtc-android docs](https://jellyfish-dev.github.io/membrane-webrtc-android/) for API documentation.
37 changes: 37 additions & 0 deletions JellyfishClient/src/main/java/com/jellyfishdev/jellyfishclient/webrtc/JellyfishWebRTC.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
package com.jellyfishdev.jellyfishclient.webrtc

typealias MembraneRTC = org.membraneframework.rtc.MembraneRTC
typealias MembraneRTCListener = org.membraneframework.rtc.MembraneRTCListener
typealias MembraneRTCError = org.membraneframework.rtc.MembraneRTCError
typealias Constants = org.membraneframework.rtc.Constants
typealias CreateOptions = org.membraneframework.rtc.CreateOptions
typealias SimulcastConfig = org.membraneframework.rtc.SimulcastConfig
typealias EncoderOptions = org.membraneframework.rtc.EncoderOptions
typealias EncoderType = org.membraneframework.rtc.EncoderType
typealias TrackEncoding = org.membraneframework.rtc.TrackEncoding
typealias LocalScreencastTrack = org.membraneframework.rtc.media.LocalScreencastTrack
typealias RemoteTrack = org.membraneframework.rtc.media.RemoteTrack
typealias LocalAudioTrack = org.membraneframework.rtc.media.LocalAudioTrack
typealias AudioTrack = org.membraneframework.rtc.media.AudioTrack
typealias LocalVideoTrack = org.membraneframework.rtc.media.LocalVideoTrack
typealias VideoTrack = org.membraneframework.rtc.media.VideoTrack
typealias CameraCapturer = org.membraneframework.rtc.media.CameraCapturer
typealias Capturer = org.membraneframework.rtc.media.Capturer
typealias Dimensions = org.membraneframework.rtc.media.Dimensions
typealias LocalTrack = org.membraneframework.rtc.media.LocalTrack
typealias MediaTrackProvider = org.membraneframework.rtc.media.MediaTrackProvider
typealias RemoteAudioTrack = org.membraneframework.rtc.media.RemoteAudioTrack
typealias RemoteVideoTrack = org.membraneframework.rtc.media.RemoteVideoTrack
typealias TrackBandwidthLimit = org.membraneframework.rtc.media.TrackBandwidthLimit
typealias VideoParameters = org.membraneframework.rtc.media.VideoParameters
typealias EncodingReason = org.membraneframework.rtc.models.EncodingReason
typealias OnEncodingChangedListener = org.membraneframework.rtc.models.OnEncodingChangedListener
typealias VadStatus = org.membraneframework.rtc.models.VadStatus
typealias OnVoiceActivityChangedListener = org.membraneframework.rtc.models.OnVoiceActivityChangedListener
typealias QualityLimitationDurations = org.membraneframework.rtc.models.QualityLimitationDurations
typealias RTCInboundStats = org.membraneframework.rtc.models.RTCInboundStats
typealias RTCOutboundStats = org.membraneframework.rtc.models.RTCOutboundStats
typealias RTCStats = org.membraneframework.rtc.models.RTCStats
typealias VideoTextureViewRenderer = org.membraneframework.rtc.ui.VideoTextureViewRenderer
typealias SerializedMediaEvent = org.membraneframework.rtc.utils.SerializedMediaEvent
typealias Payload = org.membraneframework.rtc.utils.Payload
2 changes: 1 addition & 1 deletion app/src/main/java/com/example/jellyfishandroidexample/Participant.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package com.example.jellyfishandroidexample

import org.membraneframework.rtc.media.VideoTrack
import com.jellyfishdev.jellyfishclient.webrtc.VideoTrack

data class Participant(
val id: String,
Expand Down
4 changes: 2 additions & 2 deletions app/src/main/java/com/example/jellyfishandroidexample/ParticipantVideoView.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ import androidx.compose.runtime.remember
import androidx.compose.runtime.setValue
import androidx.compose.ui.Modifier
import androidx.compose.ui.viewinterop.AndroidView
import org.membraneframework.rtc.media.VideoTrack
import org.membraneframework.rtc.ui.VideoTextureViewRenderer
import com.jellyfishdev.jellyfishclient.webrtc.VideoTextureViewRenderer
import com.jellyfishdev.jellyfishclient.webrtc.VideoTrack
import org.webrtc.RendererCommon

enum class VideoViewLayout {
Expand Down
8 changes: 4 additions & 4 deletions app/src/main/java/com/example/jellyfishandroidexample/RoomViewModel.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ import com.jellyfishdev.jellyfishclient.JellyfishClient
import com.jellyfishdev.jellyfishclient.JellyfishClientListener
import com.jellyfishdev.jellyfishclient.Peer
import com.jellyfishdev.jellyfishclient.TrackContext
import com.jellyfishdev.jellyfishclient.webrtc.LocalVideoTrack
import com.jellyfishdev.jellyfishclient.webrtc.RemoteVideoTrack
import com.jellyfishdev.jellyfishclient.webrtc.SimulcastConfig
import com.jellyfishdev.jellyfishclient.webrtc.VideoParameters
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.launch
import org.membraneframework.rtc.SimulcastConfig
import org.membraneframework.rtc.media.LocalVideoTrack
import org.membraneframework.rtc.media.RemoteVideoTrack
import org.membraneframework.rtc.media.VideoParameters

class RoomViewModel(application: Application) :
AndroidViewModel(application),
Expand Down
Loading