Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/icerockdev/moko-media
Media selection & presenting for mobile (android & ios) Kotlin Multiplatform development
https://github.com/icerockdev/moko-media
android image ios kotlin-multiplatform kotlin-native moko video
Last synced: 2 months ago
JSON representation
Media selection & presenting for mobile (android & ios) Kotlin Multiplatform development
- Host: GitHub
- URL: https://github.com/icerockdev/moko-media
- Owner: icerockdev
- License: apache-2.0
- Created: 2019-08-28T06:24:32.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-20T06:01:52.000Z (8 months ago)
- Last Synced: 2024-09-24T05:02:24.008Z (4 months ago)
- Topics: android, image, ios, kotlin-multiplatform, kotlin-native, moko, video
- Language: Kotlin
- Homepage: https://moko.icerock.dev/
- Size: 281 KB
- Stars: 118
- Watchers: 8
- Forks: 12
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- kmp-awesome - MOKO Media - System media manager (Libraries / 📱 Device)
README
[](http://www.apache.org/licenses/LICENSE-2.0) [ ](https://repo1.maven.org/maven2/dev/icerock/moko/media) 
# Mobile Kotlin media access
This is a Kotlin MultiPlatform library that provides media picking in common code (photo/video) and
video player controls.
## Table of Contents
- [Features](#features)
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [Samples](#samples)
- [Set Up Locally](#set-up-locally)
- [Contributing](#contributing)
- [License](#license)
## Features
- Capture camera photo
- Pick image from gallery
- Control video player
- **Compose Multiplatform** support
## Requirements
- Gradle version 6.8+
- Android API 16+
- iOS version 11.0+
## Installation
root build.gradle
```groovy
allprojects {
repositories {
mavenCentral()
maven { url = uri("https://jitpack.io") }
}
}
```
project build.gradle
```groovy
dependencies {
commonMainApi("dev.icerock.moko:media:0.11.0")
// Compose Multiplatform
commonMainApi("dev.icerock.moko:media-compose:0.11.0")
commonTestImplementation("dev.icerock.moko:media-test:0.11.0")
}
```
## Usage
```kotlin
class ViewModel(val mediaController: MediaPickerController) : ViewModel() {
fun onSelectPhotoPressed() {
launch {
try {
val bitmap = mediaController.pickImage(MediaControllerSource.CAMERA)
// captured photo in bitmap
} catch (_: CanceledException) {
// cancel capture
} catch (error: Throwable) {
// denied permission or file read error
}
}
}
}
```
android:
```kotlin
val viewModel = getViewModel {
val permissionsController = PermissionsController()
val mediaController = MediaPickerController(permissionsController)
ViewModel(mediaController)
}
viewModel.mediaController.bind(
lifecycle,
supportFragmentManager
) // permissioncController bind automatically
```
iOS:
```swift
let permissionsController = PermissionsController()
let mediaController = MediaPickerController(permissionsController: permissionsController, viewController: self)
let viewModel = ViewModel(mediaController: mediaController)
```
### Compose Multiplatform
```kotlin
@Composable
fun Sample() {
val factory = rememberMediaPickerControllerFactory()
val picker = remember(factory) { factory.createMediaPickerController() }
val coroutineScope = rememberCoroutineScope()
BindMediaPickerEffect(picker)
var image: ImageBitmap? by remember { mutableStateOf(null) }
image?.let {
Image(bitmap = it, contentDescription = null)
}
Button(
onClick = {
coroutineScope.launch {
val result = picker.pickImage(MediaSource.GALLERY)
image = result.toImageBitmap()
}
}
) {
Text(text = "Click on me")
}
}
```
or with moko-mvvm (with correct configuration change on android):
```kotlin
@Composable
fun Sample() {
val factory = rememberMediaPickerControllerFactory()
val viewModel: SampleViewModel = getViewModel(
key = "sample",
factory = viewModelFactory {
val picker = factory.createMediaPickerController()
SampleViewModel(picker)
}
)
BindMediaPickerEffect(viewModel.mediaPickerController)
val image: Bitmap? by viewModel.image.collectAsState()
val imageBitmap: ImageBitmap? = remember(image) { image?.toImageBitmap() }
imageBitmap?.let {
Image(bitmap = it, contentDescription = null)
}
Button(onClick = viewModel::onButtonClick) {
Text(text = "Click on me")
}
}
class SampleViewModel(
val mediaPickerController: MediaPickerController
) : ViewModel() {
private val _image: MutableStateFlow = MutableStateFlow(null)
val image: StateFlow get() = _image
fun onButtonClick() {
viewModelScope.launch {
try {
_image.value = mediaPickerController.pickImage(MediaSource.GALLERY)
} catch (exc: Exception) {
println("error $exc")
}
}
}
}
```
## Samples
More examples can be found in the [sample directory](sample).
## Set Up Locally
- In [media directory](media) contains `media` library;
- In [sample directory](sample) contains samples on android, ios & mpp-library connected to apps.
## Contributing
All development (both new features and bug fixes) is performed in `develop` branch. This
way `master` sources always contain sources of the most recently released version. Please send PRs
with bug fixes to `develop` branch. Fixes to documentation in markdown files are an exception to
this rule. They are updated directly in `master`.
The `develop` branch is pushed to `master` during release.
More detailed guide for contributers see in [contributing guide](CONTRIBUTING.md).
## License
Copyright 2019 IceRock MAG Inc
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
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.