fishjam-dev / fishjam

General purpose media server. Supports WebRTC, HLS, RTSP, SIP
https://fishjam-dev.github.io/fishjam-docs/
Apache License 2.0
197 stars 10 forks source link

Rename metadata to properties #121

Closed roznawsk closed 8 months ago

roznawsk commented 9 months ago

Rename Component.Metadata to Component.Properties

Motivation: The name "Metadata" interpreted as Data about Data is inaccurate in this case, since the Metadata structure contains information about component, such as playable?, lowLatency? or targetWindowDuration in the case of HLS component.

I think that the proposed name Properties is much better in this case and a lot more self-explanatory.

Acknowledging the stipulations set forth:

  • [ ] I hereby confirm that a Pull Request involving updates to the Software Development Kit (SDK) has been smoothly merged, currently awaits processing, or is otherwise deemed unnecessary in this context.

The changes to the SDKs will follow after implementing the File Endpoint

codecov[bot] commented 9 months ago

Codecov Report

Merging #121 (7c744bb) into main (87b32bd) will increase coverage by 0.01%. The diff coverage is 91.66%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #121 +/- ## ========================================== + Coverage 86.52% 86.53% +0.01% ========================================== Files 55 55 Lines 1009 1010 +1 ========================================== + Hits 873 874 +1 Misses 136 136 ``` | [Files](https://app.codecov.io/gh/jellyfish-dev/jellyfish/pull/121?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jellyfish-dev) | Coverage Δ | | |---|---|---| | [lib/jellyfish/component.ex](https://app.codecov.io/gh/jellyfish-dev/jellyfish/pull/121?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jellyfish-dev#diff-bGliL2plbGx5ZmlzaC9jb21wb25lbnQuZXg=) | `100.00% <100.00%> (ø)` | | | [lib/jellyfish/component/hls.ex](https://app.codecov.io/gh/jellyfish-dev/jellyfish/pull/121?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jellyfish-dev#diff-bGliL2plbGx5ZmlzaC9jb21wb25lbnQvaGxzLmV4) | `91.30% <100.00%> (ø)` | | | [lib/jellyfish/component/rtsp.ex](https://app.codecov.io/gh/jellyfish-dev/jellyfish/pull/121?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jellyfish-dev#diff-bGliL2plbGx5ZmlzaC9jb21wb25lbnQvcnRzcC5leA==) | `100.00% <ø> (ø)` | | | [lib/jellyfish\_web/api\_spec/component/hls.ex](https://app.codecov.io/gh/jellyfish-dev/jellyfish/pull/121?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jellyfish-dev#diff-bGliL2plbGx5ZmlzaF93ZWIvYXBpX3NwZWMvY29tcG9uZW50L2hscy5leA==) | `100.00% <ø> (ø)` | | | [lib/jellyfish\_web/api\_spec/component/rtsp.ex](https://app.codecov.io/gh/jellyfish-dev/jellyfish/pull/121?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jellyfish-dev#diff-bGliL2plbGx5ZmlzaF93ZWIvYXBpX3NwZWMvY29tcG9uZW50L3J0c3AuZXg=) | `100.00% <ø> (ø)` | | | [lib/jellyfish\_web/controllers/component\_json.ex](https://app.codecov.io/gh/jellyfish-dev/jellyfish/pull/121?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jellyfish-dev#diff-bGliL2plbGx5ZmlzaF93ZWIvY29udHJvbGxlcnMvY29tcG9uZW50X2pzb24uZXg=) | `100.00% <100.00%> (ø)` | | | [lib/jellyfish/room.ex](https://app.codecov.io/gh/jellyfish-dev/jellyfish/pull/121?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jellyfish-dev#diff-bGliL2plbGx5ZmlzaC9yb29tLmV4) | `85.62% <87.50%> (+0.09%)` | :arrow_up: | ------ [Continue to review full report in Codecov by Sentry](https://app.codecov.io/gh/jellyfish-dev/jellyfish/pull/121?src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jellyfish-dev). > **Legend** - [Click here to learn more](https://docs.codecov.io/docs/codecov-delta?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jellyfish-dev) > `Δ = absolute (impact)`, `ø = not affected`, `? = missing data` > Powered by [Codecov](https://app.codecov.io/gh/jellyfish-dev/jellyfish/pull/121?src=pr&el=footer&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jellyfish-dev). Last update [87b32bd...7c744bb](https://app.codecov.io/gh/jellyfish-dev/jellyfish/pull/121?src=pr&el=lastupdated&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jellyfish-dev). Read the [comment docs](https://docs.codecov.io/docs/pull-request-comments?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=jellyfish-dev).