{"id":21514983,"url":"https://github.com/skyway/skyway-recorder-sdk","last_synced_at":"2025-04-09T20:11:53.315Z","repository":{"id":57362643,"uuid":"207236010","full_name":"skyway/skyway-recorder-sdk","owner":"skyway","description":"Recorder SDK for SkyWay Enterprise Edition","archived":false,"fork":false,"pushed_at":"2023-01-31T03:40:00.000Z","size":414,"stargazers_count":5,"open_issues_count":0,"forks_count":2,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-04-09T20:11:45.059Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://webrtc.ecl.ntt.com/recording.html","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/skyway.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-09-09T06:06:11.000Z","updated_at":"2024-08-19T06:59:03.000Z","dependencies_parsed_at":"2023-02-17T07:05:41.177Z","dependency_job_id":null,"html_url":"https://github.com/skyway/skyway-recorder-sdk","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skyway%2Fskyway-recorder-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skyway%2Fskyway-recorder-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skyway%2Fskyway-recorder-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skyway%2Fskyway-recorder-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/skyway","download_url":"https://codeload.github.com/skyway/skyway-recorder-sdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248103872,"owners_count":21048245,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-23T23:53:47.449Z","updated_at":"2025-04-09T20:11:53.292Z","avatar_url":"https://github.com/skyway.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SkyWay Recorder\n\n**This is the old SkyWay repository.  Please consider migrating to the [new SkyWay](\u003chttps://skyway.ntt.com\u003e).**\n\n**これは旧SkyWayのリポジトリです。[新しいSkyWay](\u003chttps://skyway.ntt.com\u003e)への移行をご検討ください。**\n\n---\n\n`skyway-recorder` provides audio recording API.\nThe recorded files will be uploaded to Google Cloud Storage(GCS).\n\n## Prerequisite\n\nYou need to enable recording feature on SkyWay Dashboard.\n\n- Signup or login to your account.\n- Create or edit your application associated with your account.\n- Check `Enable recording feature` in the permission section.\n- Register a GCS bucket where the recording files will be uploaded.\n\n:warning: If uploading failed even once, SkyWay recording server disable the recording feature.\nYou can check the current status of the recording feature on SkyWay Dashboard.\n\n## Install\n\n```sh\nnpm i skyway-recorder\n```\n\nCDN is also available.\n\n```html\n\u003cscript src=\"https://cdn.webrtc.ecl.ntt.com/skyway-recorder-latest.js\"\u003e\u003c/script\u003e\n```\n\nYou do NOT need to install SkyWay JS-SDK alongside.\n\n## Example\n\n```js\nimport { createRecorder } from \"skyway-recorder\";\n\n(async () =\u003e {\n  const apiKey = \"5bea388b-3f95-4e1e-acb5-a34efdd0c480\";\n  const recorder = createRecorder(apiKey);\n\n  // if use authentication\n  // const recorder = createRecorder(apiKey, { auth: { timestamp, credential } });\n  // if use custom ICE configuration\n  // const recorder = createRecorder(apiKey, { iceServers: [], iceTransportPolicy: \"relay\" });\n\n  const track = await navigator.mediaDevices\n    .getUserMedia({ audio: true })\n    .then(s =\u003e s.getAudioTracks()[0]);\n\n  const res = await recorder.start(track);\n  console.log(`Your recording id: ${res.id} is now recording...`);\n\n  // ...\n\n  await recorder.stop();\n  console.log(\"recording has stopped!\");\n  console.log(\"uploading will be started soon...\");\n})();\n```\n\nThe `id` returned by `recorder.start()` is your recording id.\nYou can get recorded audio file via `${API_KEY}/${RECORDING_ID}/audio.ogg` and `meta.json` in your GCS bucket.\n\n## API\n\nSee [API.md](./API.md) for more details.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskyway%2Fskyway-recorder-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fskyway%2Fskyway-recorder-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskyway%2Fskyway-recorder-sdk/lists"}